summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/synthslant/RELEASE-HOWTO.md
blob: 13435ef66d59857053e2ecceef9fdb2383f87af7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
#  How to prepare a new release

... and not make too many mistakes.


1. Check that the work-area is clean with respect to **git**-tracked
   files.

   ``` git status ```

1. Update the date stamp of `\ProvidesPackage`.

1. (Temporarily) Zero the `\overfullrule`s of the documentation and
   the example files.

1. Thoroughly clean the work-area:

   ```make maintainer-clean```

1. Rebuild:

   ```make```

1. Check that all _*.sty_ and _*.pdf_ files are in good shape.

1. Push the documentation files created in the previous step down into
   the *docs* directory:

   ```make update-docs```

1. Undo the `\overfullrule` change.

1. Commit the changes:

   ```
   git add .
   ```

   and finally

   ```
   git commit
   ```

1. Tag the commit with the version string of `\ProvidesPackage`:

   ```git tag v1.23```

1. Push the changes to the public repository:

   ```git push origin master --tags```