1 @c -*- coding: utf-8; mode: texinfo; -*-
7 * Minor release checklist::
8 * Major release checklist::
9 * Release extra notes::
10 * Administrative policies::
14 @node Development phases
15 @section Development phases
17 There are 2.5 states of development for LilyPond.
21 @item @strong{Stable phase}:
22 Starting from the release of a new major version @code{2.x.0}, the
23 following patches @strong{MAY NOT} be merged with master:
26 @item Any change to the input syntax. If a file compiled with a
27 previous @code{2.x} version, then it must compile in the new
30 @item New features with new syntax @emph{may be committed},
31 although once committed that syntax cannot change during the
32 remainder of the stable phase.
34 @item Any change to the build dependencies (including programming
35 libraries, documentation process programs, or python modules used
36 in the buildscripts). If a contributor could compile a previous
37 lilypond @code{2.x}, then he must be able to compile the new
42 @item @strong{Development phase}:
43 Any commits are fine. Readers may be familiar with the term
44 @qq{merge window} from following Linux kernel news.
47 @item @strong{Release prep phase}:
48 TODO: I don't like that name.
50 A new git branch @code{stable/2.x} is created, and a major release
55 @item @code{stable/2.x branch}:
56 Only translation updates and important bugfixes are allows.
59 Normal @qq{stable phase} development occurs.
63 If we discover the need to change the syntax or build system, we
64 will apply it and re-start the release prep phase.
68 This marks a radical change from previous practice in LilyPond.
69 However, this setup is not intended to slow development -- as a
70 rule of thumb, the next development phase will start within a
71 month of somebody wanting to commit something which is not
72 permitted during the stable phase.
76 @node Minor release checklist
77 @section Minor release checklist
79 A @qq{minor release} means an update of @code{y} in @code{2.x.y}.
81 @subheading Pre-release
86 Switch to the release branch, get changes, prep release
90 git checkout release/unstable
92 vi Documentation/web/news-front.itexi Documentation/web/news.itexi
96 Commit, push, switch back to master:
99 git commit -m "Release: update news." Documentation/web/
102 git merge release/unstable
105 @item (optional) Check that lilypond builds from scratch in an
109 If you do not have the previous release test-output tarball, download
110 it and put it in @code{regtests/}
112 @item Build release on GUB by running:
115 make LILYPOND_BRANCH=release/unstable lilypond
122 make LILYPOND_BRANCH=stable/2.12 lilypond
125 @item Check the regtest comparison in @file{uploads/webtest/} for
126 any unintentional breakage.
128 @item If any work was done on GUB since the last release, upload
129 binaries to a temporary location, ask for feedback, and wait a day
130 or two in case there's any major problems.
135 @subheading Actual release
139 @item If you're not right user on the webserver, remove the "t"
140 from the rsync command in @file{test-lily/rsync-lily-doc.py} and
141 @file{test-lily/rsync-test.py}
143 @code{graham} owns v2.13; @code{han-wen} owns v2.12.
145 @item Upload GUB by running:
148 make lilypond-upload LILYPOND_BRANCH=master LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git
155 make lilypond-upload LILYPOND_BRANCH=stable/2.12 LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git
161 @subheading Post release
165 @item Switch back to master and get the updated news:
169 git merge release/unstable
172 @item Update @file{VERSION} in lilypond git:
175 VERSION = what you just did +0.0.1
176 DEVEL_VERSION = what you just did (i.e. is now online)
177 STABLE_VERSION = what's online
182 @item (for now) do a @code{make doc} and manually upload:
185 ### upload-lily-web-media.sh
187 BUILD_DIR=$HOME/src/build-lilypond
189 PICS=$BUILD_DIR/Documentation/pictures/out-www/
190 EXAMPLES=$BUILD_DIR/Documentation/web/ly-examples/out-www/
193 rsync -a $PICS graham@@lilypond.org:media/pictures
194 rsync -a $EXAMPLES graham@@lilypond.org:media/ly-examples
197 @item Wait a few hours for the website to update.
199 @item Email release notice to @code{info-lilypond}
205 @node Major release checklist
206 @section Major release checklist
208 A @qq{major release} means an update of @code{x} in @code{2.x.0}.
212 * write release notes. note: stringent size requirements for
213 various websites, so be brief.
215 * write preface section for manual.
217 * submit pots for translation : send url of tarball to
218 translation@@iro.umontreal.ca, mentioning lilypond-VERSION.pot
222 * Check all 2ly scripts.
224 * Run convert-ly on all files, bump parser minimum version.
226 * update links to distros providing lilypond packages? link in
227 Documentation/web/download.itexi . This has nothing to do with
228 the release, but I'm dumping this here so I'll find it when I
229 reorganize this list later. -gp
231 * Make FTP directories on lilypond.org
234 - Make new table in download.html
236 - add to documentation list
238 - revise examples tour.html/howto.html
240 - add to front-page quick links
242 - change all links to the stable documentation
244 - doc auto redirects to v2.LATEST-STABLE
246 - add these two lines to http://www.lilypond.org/robots.txt:
249 Disallow: /doc/v2.PREVIOUS-STABLE/
250 Disallow: /doc/v2.CURRENT-DEVELOPMENT/
256 comp.os.linux.announce
263 info-lilypond@@gnu.org
265 linux-audio-announce@@lists.linuxaudio.org
266 linux-audio-user@@lists.linuxaudio.org
267 linux-audio-dev@@lists.linuxaudio.org
269 tex-music@@icking-music-archive.org
272 abcusers@@blackmill.net
274 rosegarden-user@@lists.sourceforge.net
276 noteedit-user@@berlios.de
278 gmane.comp.audio.fomus.devel
279 gmane.linux.audio.users
280 gmane.linux.audio.announce
281 gmane.comp.audio.rosegarden.devel
288 http://www.apple.com/downloads
289 harmony-central.com (news@@harmony-central.com)
290 versiontracker.com [auto]
293 https://savannah.gnu.org/news/submit.php?group_id=1673 @c => planet.gnu.org
296 @node Release extra notes
297 @section Release extra notes
299 @subsubheading Regenerating regression tests
301 Regenerating regtests (if the lilypond-book naming has changed):
306 git checkout release/lilypond-X.Y.Z-A
309 take lilypond-book and any related makefile updates from the
313 - configure; make; make test
316 tar -cjf lilypond-X.Y.Z-A.test-output.tar.bz2 input/regression/out-test/
319 mv lilypond-X.Y.Z-A.test-output.tar.bz2 ../gub/regtests/
330 @subsubheading stable/2.12
332 If releasing stable/2.12, then:
337 apply doc patch: patches/rsync-lily.patch (or something like
341 change infodir in gub/specs/lilypond-doc.py from "lilypond.info"
342 to "lilypond-web.info"
345 @subsubheading Updating a release (changing a in x.y.z-a)
347 Really tentative instructions, almost certainly can be done
353 change the VERSION back to release you want. push change.
354 (hopefully you'll have forgotten to update it when you made your
358 make sure that there aren't any lilypond files floating around in
359 target/ (like usr/bin/lilypond).
362 build the specific package(s) you want, i.e.
365 bin/gub mingw::lilypond-installer
366 make LILYPOND_BRANCH=stable/2.12 -f lilypond.make doc
367 bin/gub --platform=darwin-x86 'git://git.sv.gnu.org/lilypond-doc.git?branch=stable/2.12'
372 build everything with the normal "make lilypond", then (maybe)
373 manually delete stuff you don't want to upload.
376 manually upload them. good luck figuring out the rsync
377 command(s). Hints are in test-lily/
381 run the normal lilypond-upload command, and (maybe) manually
382 delete stuff you didn't want to upload from the server.
387 @node Administrative policies
388 @section Administrative policies
390 Not really release-specific notes, but I don't see enough material
391 here to make it a separate chapter, and the release person will
392 probably be the one taking care of this anyway.
394 @subsubheading Language-specific mailing lists
396 A translator can ask for an official lilypond-xy mailing list once
397 they've finished all @qq{priority 1} translation items.
399 @subsubheading Performing yearly copyright update (@qq{grand-replace})
401 At the start of each year, copyright notices for all source files
402 should be refreshed by running the following command from the top of
409 Internally, this invokes the script @file{scripts/build/grand-replace.py},
410 which performs a regular expression substitution for old-year -> new-year
411 wherever it finds a valid copyright notice.
413 Note that snapshots of third party files such as @file{texinfo.tex} should
414 not be included in the automatic update; @file{grand-replace.py} ignores these
415 files if they are listed in the variable @code{copied_files}.