diff options
Diffstat (limited to 'doc/RELEASING.md')
-rw-r--r-- | doc/RELEASING.md | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/doc/RELEASING.md b/doc/RELEASING.md new file mode 100644 index 00000000..f755d610 --- /dev/null +++ b/doc/RELEASING.md | |||
@@ -0,0 +1,99 @@ | |||
1 | Releasing a New Monitoring Plugins Version | ||
2 | ========================================== | ||
3 | |||
4 | Throughout this document, it is assumed that the current Monitoring | ||
5 | Plugins version is 2.2.1, and that we're about to publish version 2.3. | ||
6 | |||
7 | Before you start | ||
8 | ---------------- | ||
9 | |||
10 | - Check Travis CI status. | ||
11 | - Update local Git repository to the current `master` tip. For a | ||
12 | maintenance release (e.g., version 2.2.2), update to the current | ||
13 | `maint-2.2` tip, instead. | ||
14 | |||
15 | Prepare and commit files | ||
16 | ------------------------ | ||
17 | |||
18 | - Update `NEWS` from `git log --reverse v2.2.1..` output, and specify | ||
19 | the release version/date. | ||
20 | - Update `configure.ac` and `NP-VERSION-GEN` with new version. | ||
21 | - Update `AUTHORS` if there are new team members. | ||
22 | - Update `THANKS.in`: | ||
23 | |||
24 | tools/update-thanks | ||
25 | |||
26 | - Commit the results: | ||
27 | |||
28 | git commit configure.ac NP-VERSION-GEN AUTHORS THANKS.in | ||
29 | |||
30 | Create annotated tag | ||
31 | -------------------- | ||
32 | |||
33 | git tag -a v2.3 -m v2.3 | ||
34 | |||
35 | Push the code and tag to GitHub | ||
36 | ------------------------------- | ||
37 | |||
38 | git push monitoring-plugins master | ||
39 | git push monitoring-plugins v2.3 | ||
40 | |||
41 | Create new maintenance branch | ||
42 | ----------------------------- | ||
43 | |||
44 | _Only necessary when creating a feature release._ | ||
45 | |||
46 | git checkout -b maint-2.3 v2.3 | ||
47 | git push -u monitoring-plugins maint-2.3 | ||
48 | |||
49 | Checkout new version | ||
50 | -------------------- | ||
51 | |||
52 | rm -rf /tmp/plugins | ||
53 | git archive --prefix=tmp/plugins/ v2.3 | (cd /; tar -xf -) | ||
54 | |||
55 | Build the tarball | ||
56 | ----------------- | ||
57 | |||
58 | cd /tmp/plugins | ||
59 | tools/setup | ||
60 | ./configure | ||
61 | make dist | ||
62 | |||
63 | Upload tarball to our web site | ||
64 | ------------------------------ | ||
65 | |||
66 | scp monitoring-plugins-2.3.tar.gz \ | ||
67 | plugins@orwell.monitoring-plugins.org:web/download/ | ||
68 | |||
69 | Generate SHA1 checksum files on web site | ||
70 | ---------------------------------------- | ||
71 | |||
72 | ssh plugins@orwell.monitoring-plugins.org \ | ||
73 | '(cd web/download; \ | ||
74 | $HOME/bin/create-checksum monitoring-plugins-2.3.tar.gz)' | ||
75 | |||
76 | Announce new release | ||
77 | -------------------- | ||
78 | |||
79 | - In the site.git repository, | ||
80 | |||
81 | - create `web/input/news/release-2-3.md`, | ||
82 | - update the `plugins_release` version in `web/macros.py`, and | ||
83 | |||
84 | git add web/input/news/release-2-3.md | ||
85 | git commit web/input/news/release-2-3.md web/macros.py | ||
86 | git push origin master | ||
87 | |||
88 | - Post an announcement on (at least) the following mailing lists: | ||
89 | |||
90 | - <announce@monitoring-plugins.org> | ||
91 | - <help@monitoring-plugins.org> (set `Reply-To:` to this one) | ||
92 | |||
93 | - Ask the social media department to announce the release on Twitter :-) | ||
94 | |||
95 | If you want to mention the number of contributors in the announcement: | ||
96 | |||
97 | git shortlog -s v2.2.1..v2.3 | wc -l | ||
98 | |||
99 | # vim:set filetype=markdown textwidth=72: | ||