summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/RELEASING39
-rw-r--r--doc/RELEASING.md99
2 files changed, 99 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..f755d610
--- /dev/null
+++ b/doc/RELEASING.md
@@ -0,0 +1,99 @@
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.
6
7Before 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
15Prepare 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
30Create annotated tag
31--------------------
32
33 git tag -a v2.3 -m v2.3
34
35Push the code and tag to GitHub
36-------------------------------
37
38 git push monitoring-plugins master
39 git push monitoring-plugins v2.3
40
41Create 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
49Checkout new version
50--------------------
51
52 rm -rf /tmp/plugins
53 git archive --prefix=tmp/plugins/ v2.3 | (cd /; tar -xf -)
54
55Build the tarball
56-----------------
57
58 cd /tmp/plugins
59 tools/setup
60 ./configure
61 make dist
62
63Upload tarball to our web site
64------------------------------
65
66 scp monitoring-plugins-2.3.tar.gz \
67 plugins@orwell.monitoring-plugins.org:web/download/
68
69Generate 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
76Announce 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
95If 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: