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