1 @c -*- coding: utf-8; mode: texinfo; -*-
7 * Minor release checklist::
8 * Major release checklist::
9 * Release extra notes::
13 @node Development phases
14 @section Development phases
16 There are 2.5 states of development for LilyPond.
20 @item @strong{Stable phase}:
21 Starting from the release of a new major version @code{2.x.0}, the
22 following patches @strong{MAY NOT} be merged with master:
25 @item Any change to the input syntax. If a file compiled with a
26 previous @code{2.x} version, then it must compile in the new
29 @item New features with new syntax @emph{may be committed},
30 although once committed that syntax cannot change during the
31 remainder of the stable phase.
33 @item Any change to the build dependencies (including programming
34 libraries, documentation process programs, or python modules used
35 in the buildscripts). If a contributor could compile a previous
36 lilypond @code{2.x}, then he must be able to compile the new
41 @item @strong{Development phase}:
42 Any commits are fine. Readers may be familiar with the term
43 @qq{merge window} from following Linux kernel news.
46 @item @strong{Release prep phase}:
47 TODO: I don't like that name.
49 A new git branch @code{stable/2.x} is created, and a major release
54 @item @code{stable/2.x branch}:
55 Only translation updates and important bugfixes are allows.
58 Normal @qq{stable phase} development occurs.
62 If we discover the need to change the syntax or build system, we
63 will apply it and re-start the release prep phase.
67 This marks a radical change from previous practice in LilyPond.
68 However, this setup is not intended to slow development -- as a
69 rule of thumb, the next development phase will start within a
70 month of somebody wanting to commit something which is not
71 permitted during the stable phase.
75 @node Minor release checklist
76 @section Minor release checklist
78 A @qq{minor release} means an update of @code{y} in @code{2.x.y}.
80 @subheading Pre-release
85 Switch to the release branch, get changes, prep release
89 git checkout release/unstable
91 vi Documentation/web/news-front.itexi Documentation/web/news.itexi
95 Commit, push, switch back to master:
98 git commit -m "Release: update news." Documentation/web/
102 @item (optional) Check that lilypond builds from scratch in an
106 If you do not have the previous release test-output tarball, download
107 it and put it in @code{regtests/}
109 @item Build release on GUB by running:
112 make LILYPOND_BRANCH=release/unstable lilypond
119 make LILYPOND_BRANCH=stable/2.12 lilypond
122 @item Check the regtest comparison in @file{uploads/webtest/} for
123 any unintentional breakage.
125 Note that this test uses the bounding boxes inside lilypond.
126 Errors in ghostscript don't generate differences inside lilypond,
127 so they are not registered in the regtest comparison.
129 @item If any work was done on GUB since the last release, upload
130 binaries to a temporary location, ask for feedback, and wait a day
131 or two in case there's any major problems.
136 @subheading Actual release
140 @item If you're not right user on the webserver, remove the "t"
141 from the rsync command in @file{test-lily/rsync-lily-doc.py} and
142 @file{test-lily/rsync-test.py}
144 @code{graham} owns v2.13; @code{han-wen} owns v2.12.
146 @item Upload GUB by running:
149 make lilypond-upload LILYPOND_BRANCH=release/unstable LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git
156 make lilypond-upload LILYPOND_BRANCH=stable/2.12 LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git
162 @subheading Post release
166 @item Switch back to master and get the updated news:
170 git merge release/unstable
173 @item Update @file{VERSION} in lilypond git and upload changes:
177 VERSION = what you just did +0.0.1
178 DEVEL_VERSION = what you just did (i.e. is now online)
179 STABLE_VERSION = what's online
185 git commit -m "Release: bump version." VERSION
190 @item (for now) do a @code{make doc} and manually upload:
193 ### upload-lily-web-media.sh
195 BUILD_DIR=$HOME/src/build-lilypond
197 PICS=$BUILD_DIR/Documentation/pictures/out-www/
198 EXAMPLES=$BUILD_DIR/Documentation/web/ly-examples/out-www/
201 rsync -a $PICS graham@@lilypond.org:media/pictures
202 rsync -a $EXAMPLES graham@@lilypond.org:media/ly-examples
205 @item Wait a few hours for the website to update.
207 @item Email release notice to @code{info-lilypond}
213 @node Major release checklist
214 @section Major release checklist
216 A @qq{major release} means an update of @code{x} in @code{2.x.0}.
218 - happens when we have 0 Critical issues for two weeks (14 days).
223 * write release notes. note: stringent size requirements for
224 various websites, so be brief.
226 * write preface section for manual.
228 * submit pots for translation : send url of tarball to
229 translation@@iro.umontreal.ca, mentioning lilypond-VERSION.pot
233 * Check all 2ly scripts.
235 * Run convert-ly on all files, bump parser minimum version.
237 * update links to distros providing lilypond packages? link in
238 Documentation/web/download.itexi . This has nothing to do with
239 the release, but I'm dumping this here so I'll find it when I
240 reorganize this list later. -gp
242 * Make FTP directories on lilypond.org
245 - Make new table in download.html
247 - add to documentation list
249 - revise examples tour.html/howto.html
251 - add to front-page quick links
253 - change all links to the stable documentation
255 - make a link from the old unstable to the next stable in
256 lilypond.org's /doc/ dir. Keep all previous unstable->stable
259 - doc auto redirects to v2.LATEST-STABLE
261 - add these two lines to http://www.lilypond.org/robots.txt:
264 Disallow: /doc/v2.PREVIOUS-STABLE/
265 Disallow: /doc/v2.CURRENT-DEVELOPMENT/
268 - check for emergencies the docs:
271 grep FIXME --exclude "misc/*" --exclude "*GNUmakefile" \
272 --exclude "snippets/*" ????*/*
275 - check for altered regtests, and document as necessary. (update
279 git diff -u -r release/2.12.0-1 -r release/2.13.13-1 input/regression/
286 comp.os.linux.announce
293 info-lilypond@@gnu.org
295 linux-audio-announce@@lists.linuxaudio.org
296 linux-audio-user@@lists.linuxaudio.org
297 linux-audio-dev@@lists.linuxaudio.org
299 tex-music@@icking-music-archive.org
302 abcusers@@blackmill.net
304 rosegarden-user@@lists.sourceforge.net
306 noteedit-user@@berlios.de
308 gmane.comp.audio.fomus.devel
309 gmane.linux.audio.users
310 gmane.linux.audio.announce
311 gmane.comp.audio.rosegarden.devel
318 http://www.apple.com/downloads
319 harmony-central.com (news@@harmony-central.com)
320 versiontracker.com [auto]
323 https://savannah.gnu.org/news/submit.php?group_id=1673 @c => planet.gnu.org
326 @node Release extra notes
327 @section Release extra notes
329 @subsubheading Regenerating regression tests
331 Regenerating regtests (if the lilypond-book naming has changed):
336 git checkout release/lilypond-X.Y.Z-A
339 take lilypond-book and any related makefile updates from the
343 - configure; make; make test
346 tar -cjf lilypond-X.Y.Z-A.test-output.tar.bz2 input/regression/out-test/
349 mv lilypond-X.Y.Z-A.test-output.tar.bz2 ../gub/regtests/
360 @subsubheading stable/2.12
362 If releasing stable/2.12, then:
367 apply doc patch: patches/rsync-lily.patch (or something like
371 change infodir in gub/specs/lilypond-doc.py from "lilypond.info"
372 to "lilypond-web.info"
375 @subsubheading Updating a release (changing a in x.y.z-a)
377 Really tentative instructions, almost certainly can be done
383 change the VERSION back to release you want. push change.
384 (hopefully you'll have forgotten to update it when you made your
388 make sure that there aren't any lilypond files floating around in
389 target/ (like usr/bin/lilypond).
392 build the specific package(s) you want, i.e.
395 bin/gub mingw::lilypond-installer
396 make LILYPOND_BRANCH=stable/2.12 -f lilypond.make doc
397 bin/gub --platform=darwin-x86 'git://git.sv.gnu.org/lilypond-doc.git?branch=stable/2.12'
402 build everything with the normal "make lilypond", then (maybe)
403 manually delete stuff you don't want to upload.
406 manually upload them. good luck figuring out the rsync
407 command(s). Hints are in test-lily/
411 run the normal lilypond-upload command, and (maybe) manually
412 delete stuff you didn't want to upload from the server.