monotone

monotone Mtn Source Tree

Root/notes/release-checklist.txt

1How to release a new version of monotone
2----------------------------------------
3
40) Make sure that the buildbot looks reasonably green. Let's not
5 release stuff that's known to be broken on any major platforms, eh?
6
71) Write user-readable release notes at the top of the NEWS file,
8 roughly following the format of existing entries. Make sure to
9 mention any incompatibilities at the top, and generally it's a good
10 idea to put cool new stuff above nice-but-not-as-exciting stuff.
11
12 A useful command:
13
14 $ mtn log --from h:net.venge.monotone --to t:monotone-*
15
16 Commit your release notes, so other people can see them.
17
181.5) Get people to read over your release notes, it's really easy to
19 make mistakes or have stupid grammatical errors here.
20
212) Update the UPGRADE file. At the very least, bump the version
22 number in the first line. This file should always contain a
23 complete description of how to upgrade from any version of monotone
24 to the latest release -- you may need to tweak or remove earlier
25 entries to keep this true.
26
27 Commit your changes.
28
293) Double-check that INSTALL, AUTHORS, and README don't need any
30 updates. If they do, make them.
31
324) Update version numbers. The following files need to be touched:
33 configure.ac: change the call to AC_INIT
34 monotone.spec: change the "Version:" field, and add an entry to
35 the %changelog section.
36 win32/monotone.iss: look out for "#define APPVERS"
37 visualc/config.h: the version number is mentioned several times,
38 don't miss any.
39 debian/changelog: rather than modifying this file directly, run
40 the command "debchange -v <NEW VERSION>-0.1". (If you screw up
41 and need to roll a new unofficial package, use "debchange -i"
42 to increment this number.)
43
44 Commit your changes.
45
465) Okay, everything should be ready to go... double-check that:
47 -- you've done the above steps correctly
48 -- you've entered the correct date at the top of the NEWS file
49 (esp. important when you wrote the notes a few days ago so
50 people could look them over!)
51
526) Build and test the source package, in a clean checkout (if you use
53 your main workspace, you increase the changes of accidentally
54 picking up weird stuff):
55
56 $ mtn co -r h:net.venge.monotone SOMEDIR
57 $ cd SOMEDIR
58 $ autoreconf -i && ./configure && make distcheck
59
60 Wait a long time, eventually it will either bomb out, or say
61 "monotone-0.<whatever>.tar.gz is ready for distribution". If it
62 bombs out, fix it, otherwise, SOMEDIR/monotone-<NEW VERSION>.tar.gz
63 is the source package.
64
657) Build docs for the website:
66
67 $ tar xvzf SOMEDIR/monotone-<NEW VERSION>.tar.gz
68 $ cd monotone-<NEW VERSION>
69 $ ./configure
70 $ LANG=C make monotone.pdf html
71
728) Upload everything to the website (uses monotone):
73
74 # This requires that you have registered a SSH version 2 public key
75 # with the administrators of monotone.ca, currently richard@levitte.org.
76 #
77 $ mkdir <NEW VERSION>
78 $ mv SOMEDIR/monotone-<NEW VERSION>.tar.gz <NEW VERSION>/
79 $ scp -r <NEW VERSION> mtn-uploads@monotone.ca:downloads/
80
81 # The rest is done via monotone.
82 #
83 $ mtn -d DATABASE co -b net.venge.monotone.web WEBDIR
84 $ cp monotone-<NEW VERSION>/{NEWS,INSTALL,UPGRADE,README,monotone.pdf,monotone.html} \
85 WEBDIR/
86 $ rm -rf WEBDIR/docs
87 $ cp -r monotone-<NEW VERSION>/html WEBDIR/docs
88 $ rm WEBDIR/figures/*
89 $ cp monotone-<NEW VERSION>/figures/*.png WEBDIR/figures/
90 $ cd WEBDIR
91 $ mtn drop --missing
92 $ mtn add --unknown
93 $ mtn ci -m "Updates related to the release of monotone <NEW VERSION>"
94 $ mtn sync
95
969) Update index.html on the website to state the latest version at the
97 top, and modify the list of download links to point to the new
98 version.
99
100 $ cd WEBDIR
101 $ vi index.html
102 $ mtn ci -m "Updates related to the release of monotone <NEW VERSION>"
103 $ mtn sync
104
10510) Update releases.xml on the website so the RSS feed contains information
106 for the newly released version. Don't forget to update the feed's
107 global pubDate date as well as the invididual item's pubDate
108 and ensure you use the correct datetime format. Add an <enclosure>
109 which links to the monotone source tarball and add the proper length
110 as attribute.
111 Finally you should just copy'n'paste the NEWS entry for the NEW VERSION
112 directly into the description inside a CDATA field and do a couple of
113 searches and replaces to add HTML formatting for a nicer display.
114
115 $ cd WEBDIR
116 $ vi releases.xml
117 $ mtn ci -m "Updates RSS feed for monotone <NEW VERSION>"
118 $ mtn sync
119
12011) Once you're pretty sure things have gone well, tag the source:
121
122 $ mtn tag <REVISION> monotone-<NEW VERSION>
123
124 This is the last possible moment to back out!
125
126 $ mtn sync
127
12812) Change the topic in the IRC channel to state the new version
129 number.
130
13113) Send out a release announcement. Format is something like:
132
133 To: monotone-announce@nongnu.org
134 CC: monotone-devel@nongnu.org
135 Subject: [ANNOUNCE] monotone <NEW VERSION> released
136
137 <a few lines stating the new version and where the website is>
138
139 <the release notes copy/pasted from the top of NEWS>
140
141 <sign off>
142
14314) Submit a release announcement to freshmeat.net.
144
14515) Note any mistakes you made and update this file accordingly for
146 next time.
147
14816) Party!

Archive Download this file

Branches

Tags

Quick Links:     www.monotone.ca    -     Downloads    -     Documentation    -     Wiki    -     Code Forge    -     Build Status