X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fcontributor%2Frelease-work.itexi;h=b1a79e477fd0ce5fcbf4960055a613c2260f3797;hb=42c861fae113f268785428586c1ed746ddb9f4e7;hp=0a503a278fc3ab987b1e6fcca95f0e4d0164ff2c;hpb=794dcbdb52faf4292036cd1b0270a956cf4316a3;p=lilypond.git diff --git a/Documentation/contributor/release-work.itexi b/Documentation/contributor/release-work.itexi index 0a503a278f..b1a79e477f 100644 --- a/Documentation/contributor/release-work.itexi +++ b/Documentation/contributor/release-work.itexi @@ -1,12 +1,12 @@ -@c -*- coding: us-ascii; mode: texinfo; -*- +@c -*- coding: utf-8; mode: texinfo; -*- @node Release work @chapter Release work @menu -* Development phases:: -* Minor release checklist:: -* Major release checklist:: -* Making a release:: +* Development phases:: +* Minor release checklist:: +* Major release checklist:: +* Release extra notes:: @end menu @@ -44,7 +44,7 @@ Any commits are fine. Readers may be familiar with the term @item @strong{Release prep phase}: -FIXME: I don't like that name. +TODO: I don't like that name. A new git branch @code{stable/2.x} is created, and a major release is made in two weeks. @@ -77,7 +77,142 @@ permitted during the stable phase. A @qq{minor release} means an update of @code{y} in @code{2.x.y}. -email brief summary to info-lilypond +@subheading Pre-release + +@enumerate + +@item +Switch to the release branch, get changes, prep release +announcement: + +@example +git checkout release/unstable +git merge origin +vi Documentation/web/news-front.itexi Documentation/web/news.itexi +@end example + +@item +Commit, push, switch back to master: + +@example +git commit -m "Release: update news." Documentation/web/ +git push origin +@end example + +@item (optional) Check that lilypond builds from scratch in an +out-of-tree build. + +@item +If you do not have the previous release test-output tarball, download +it and put it in @code{regtests/} + +@item Build release on GUB by running: + +@example +make LILYPOND_BRANCH=release/unstable lilypond +@end example + +@noindent +or something like: + +@example +make LILYPOND_BRANCH=stable/2.12 lilypond +@end example + +@item Check the regtest comparison in @file{uploads/@/webtest/} for +any unintentional breakage. More info in +@ref{Precompiled regression tests} + +@item If any work was done on GUB since the last release, upload +binaries to a temporary location, ask for feedback, and wait a day +or two in case there's any major problems. Or live dangerously +and just add a sentence to the release notes. Or live even more +dangerously, and don't tell anybody anything. + +@end enumerate + + +@subheading Actual release + +@enumerate + +@item If you're not right user on the webserver, remove the "t" +from the rsync command in @file{test@/-lily/@/rsync@/-lily@/-doc@/.py} and +@file{test@/-lily/@/rsync@/-test@/.py} + +@code{graham} owns v2.13; @code{han-wen} owns v2.12. + +@item Upload GUB by running: + +@example +make lilypond-upload LILYPOND_BRANCH=release/unstable LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git +@end example + +@noindent +or something like: + +@example +make lilypond-upload LILYPOND_BRANCH=stable/2.12 LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git +@end example + +@end enumerate + + +@subheading Post release + +@enumerate + +@item Switch back to master and get the updated news: + +@example +git checkout master +git merge release/unstable +@end example + +@item Update @file{VERSION} in lilypond git and upload changes: + +@example +vi VERSION +@end example + +@itemize +@item +VERSION = what you just did +0.0.1 + +@item +DEVEL_VERSION = what you just did (i.e. is now online) + +@item +STABLE_VERSION = what's online (probably no change here) + +@end itemize + +@example +git commit -m "Release: bump version." VERSION +git push origin +@end example + + +@item (for now) do a @code{make doc} and manually upload: + +@example +### upload-lily-web-media.sh +#!/bin/sh +BUILD_DIR=$HOME/src/build-lilypond + +PICS=$BUILD_DIR/Documentation/pictures/out-www/ +EXAMPLES=$BUILD_DIR/Documentation/web/ly-examples/out-www/ + +cd $BUILD_DIR +rsync -a $PICS graham@@lilypond.org:media/pictures +rsync -a $EXAMPLES graham@@lilypond.org:media/ly-examples +@end example + +@item Wait a few hours for the website to update. + +@item Email release notice to @code{info-lilypond} + +@end enumerate @@ -86,6 +221,9 @@ email brief summary to info-lilypond A @qq{major release} means an update of @code{x} in @code{2.x.0}. +- happens when we have 0 Critical issues for two weeks (14 days). + + Before release: * write release notes. note: stringent size requirements for @@ -93,7 +231,7 @@ Before release: * write preface section for manual. -* submit pots for translation : send url of tarball to +* submit pots for translation: send url of tarball to translation@@iro.umontreal.ca, mentioning lilypond-VERSION.pot * Check reg test @@ -102,6 +240,11 @@ translation@@iro.umontreal.ca, mentioning lilypond-VERSION.pot * Run convert-ly on all files, bump parser minimum version. +* update links to distros providing lilypond packages? link in +Documentation/web/download.itexi . This has nothing to do with +the release, but I'm dumping this here so I'll find it when I +reorganize this list later. -gp + * Make FTP directories on lilypond.org * website: @@ -115,8 +258,34 @@ translation@@iro.umontreal.ca, mentioning lilypond-VERSION.pot - change all links to the stable documentation + - make a link from the old unstable to the next stable in + lilypond.org's /doc/ dir. Keep all previous unstable->stable + doc symlinks. + - doc auto redirects to v2.LATEST-STABLE + - add these two lines to http://www.lilypond.org/robots.txt: + +@example +Disallow: /doc/v2.PREVIOUS-STABLE/ +Disallow: /doc/v2.CURRENT-DEVELOPMENT/ +@end example + +- check for emergencies the docs: + +@example +grep FIXME --exclude "misc/*" --exclude "*GNUmakefile" \ + --exclude "snippets/*" ????*/* +@end example + +- check for altered regtests, and document as necessary. (update + tags as appropriate) + +@example +git diff -u -r release/2.12.0-1 -r release/2.13.13-1 input/regression/ +@end example + + News: comp.music.research @@ -157,74 +326,98 @@ Web: versiontracker.com [auto] hitsquad.com [auto] http://www.svgx.org + https://savannah.gnu.org/news/submit.php?group_id=1673 @c => planet.gnu.org +@node Release extra notes +@section Release extra notes -@node Making a release -@section Making a release +@subsubheading Regenerating regression tests -@subheading Technical notes - -To build GUB: +Regenerating regtests (if the lilypond-book naming has changed): @itemize -@item -Run the following (from the gub/ dir): +@item +git checkout release/lilypond-X.Y.Z-A -@example -make -f lilypond.make update-versions -@end example +@item +take lilypond-book and any related makefile updates from the +latest git. @item -Download -@uref{http://lilypond.org/download/binaries/test-output/lilypond-2.13.0-0.test-output.tar.bz2,lilypond-2.13.0-0.test-output.tar.bz2} +- configure; make; make test -@item -Copy / move / link it to uploads, but rename it to -@file{lilypond-2-13.test-output.tar.bz2} +@item +tar -cjf lilypond-X.Y.Z-A.test-output.tar.bz2 input/regression/out-test/ @item -Run: +mv lilypond-X.Y.Z-A.test-output.tar.bz2 ../gub/regtests/ -@example +@item +cd ../gub/regtests/ + +@item make lilypond -@end example @end itemize -To upload: -@itemize +@subsubheading stable/2.12 -@item remove the "t" from the rsync command in test-lily/rsync-lily-doc.py +If releasing stable/2.12, then: -@item run: +@itemize -@example -python test-lily/upload.py --branch=master --url git://git.sv.gnu.org/lilypond.git --execute -@end example +@item +apply doc patch: patches/rsync-lily.patch (or something like +that) +@item +change infodir in gub/specs/lilypond-doc.py from "lilypond.info" +to "lilypond-web.info" @end itemize +@subsubheading Updating a release (changing a in x.y.z-a) -@subheading Policy notes +Really tentative instructions, almost certainly can be done +better. -@itemize +@enumerate @item -Build with GUB, and check the regtests. +change the VERSION back to release you want. push change. +(hopefully you'll have forgotten to update it when you made your +last release) @item -Upload the tarballs and sh scripts. +make sure that there aren't any lilypond files floating around in +target/ (like usr/bin/lilypond). @item -(if major) -Branch MASTER to stable/2.x. +build the specific package(s) you want, i.e. + +@example +bin/gub mingw::lilypond-installer +make LILYPOND_BRANCH=stable/2.12 -f lilypond.make doc +bin/gub --platform=darwin-x86 'git://git.sv.gnu.org/lilypond-doc.git?branch=stable/2.12' +@end example + +or + +build everything with the normal "make lilypond", then (maybe) +manually delete stuff you don't want to upload. @item -Make announcement. +manually upload them. good luck figuring out the rsync +command(s). Hints are in test-lily/ + +or + +run the normal lilypond-upload command, and (maybe) manually +delete stuff you didn't want to upload from the server. + +@end enumerate -@end itemize