]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/contributor/release-work.itexi
CG: add updating of lilypond.pot in the release process
[lilypond.git] / Documentation / contributor / release-work.itexi
index 2be94a1f44a14cec32c2ffd40e472b0fefa192ef..4828d1ae0ea348b461df37346347411e7177fb93 100644 (file)
@@ -75,26 +75,53 @@ A @qq{minor release} means an update of @code{y} in @code{2.x.y}.
 
 @item
 Switch to the release branch, get changes, prep release
-announcement:
+announcement.  This requires a clean index and work tree.  If the
+checkout displays modified files, you might want to run @code{git reset
+--hard} before continuing.
 
 @example
-git checkout release/unstable
+git fetch
+git checkout origin/release/unstable
 git merge origin
+make po-replace
 vi Documentation/web/news-front.itexi Documentation/web/news.itexi
 @end example
 
 @item
-Commit, push, switch back to master:
+Commit, push, switch back to master (or wherever else):
 
 @example
+git commit -m "PO: update template." po/lilypond.pot
 git commit -m "Release: update news." Documentation/web/
-git push origin
+git push origin HEAD:release/unstable
+git checkout master
 @end example
 
 @item
 If you do not have the previous release test-output tarball, download
 it and put it in @code{regtests/}
 
+@item Prepare GUB environment by running:
+
+@example
+### my-gub.sh
+# special terminal, and default PATH environment.
+# import these special environment vars:
+#   HOME, HTTP_PROXY, TERM
+env -i \
+  HOME=$HOME \
+  HTTP_PROXY=$HTTP_PROXY \
+  bash --rcfile my-bashrc
+@end example
+
+@example
+### my-bashrc
+export PS1="\[\e[1;33mGUB-ENV \w\]$ \[\e[0m\]"
+export PATH=$PATH
+export TERM=xterm
+@end example
+
+
 @item Build release on GUB by running:
 
 @example
@@ -108,7 +135,7 @@ or something like:
 make LILYPOND_BRANCH=stable/2.12 lilypond
 @end example
 
-@item Check the regtest comparison in @file{uploads/@/webtest/} for
+@item Check the regtest comparison in @file{uploads/webtest/} for
 any unintentional breakage.  More info in
 @ref{Precompiled regression tests}.
 
@@ -126,24 +153,31 @@ or two in case there's any major problems.
 @enumerate
 
 @item If you're not the 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{t} from the rsync command in:
+
+@example
+test-lily/rsync-lily-doc.py
+test-lily/rsync-test.py
+@end example
 
 @code{graham} owns v2.13; @code{han-wen} owns v2.12.
 
 @item Upload GUB by running:
 
-@smallexample
-make lilypond-upload LILYPOND_BRANCH=release/unstable LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git
-@end smallexample
+@example
+make lilypond-upload \
+  LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git \
+  LILYPOND_BRANCH=release/unstable
+@end example
 
 @noindent
 or something like:
 
-@smallexample
-make lilypond-upload LILYPOND_BRANCH=stable/2.12 LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git
-@end smallexample
+@example
+make lilypond-upload \
+  LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git \
+  LILYPOND_BRANCH=stable/2.12
+@end example
 
 @end enumerate
 
@@ -155,8 +189,8 @@ make lilypond-upload LILYPOND_BRANCH=stable/2.12 LILYPOND_REPO_URL=git://git.sv.
 @item Switch back to master and get the updated news:
 
 @example
-git checkout master
-git merge release/unstable
+git checkout origin/staging
+git merge origin/release/unstable
 @end example
 
 @item Update @file{VERSION} in lilypond git and upload changes:
@@ -179,7 +213,7 @@ STABLE_VERSION = what's online (probably no change here)
 
 @example
 git commit -m "Release: bump version." VERSION
-git push origin
+git push origin HEAD:staging
 @end example
 
 
@@ -191,7 +225,7 @@ git push origin
 BUILD_DIR=$HOME/src/build-lilypond
 
 PICS=$BUILD_DIR/Documentation/pictures/out-www/
-EXAMPLES=$BUILD_DIR/Documentation/web/ly-examples/out-www/
+EXAMPLES=$BUILD_DIR/Documentation/ly-examples/out-www/
 
 cd $BUILD_DIR
 rsync -a $PICS graham@@lilypond.org:media/pictures
@@ -213,134 +247,187 @@ A @qq{major release} means an update of @code{x} in @code{2.x.0}.
 
 @subheading Main requirements
 
-It happens when we have 0 Critical issues for two weeks (14 days)
-after the latest release candidate.
+This is the current official guidelines.
 
-@subheading Housekeeping requirements
+@itemize
+@item
+0 Critical issues for two weeks (14 days) after the latest release
+candidate.
 
-Before the release:
+@end itemize
+
+
+@subheading Potential requirements
+
+These might become official guidelines in the future.
 
 @itemize
 @item
-write release notes.  note: stringent size requirements for
-various websites, so be brief.
+Check reg test
 
 @item
-* write preface section for manual.
+Check all 2ly scripts
 
 @item
-* submit pots for translation: send url of tarball to
-translation@@iro.umontreal.ca, mentioning lilypond-VERSION.pot
+Check for emergencies the docs:
+
+@example
+grep FIXME --exclude "misc/*" --exclude "*GNUmakefile" \
+  --exclude "snippets/*" ????*/*
+@end example
 
 @item
-* Check reg test
+Check for altered regtests, and document as necessary.  (update
+numbers in the following command as appropriate)
+
+@example
+git diff -u -r release/2.12.0-1 -r release/2.13.13-1 input/regression/
+@end example
+
+@end itemize
+
+
+@subheading Housekeeping requirements
+
+Before the release:
 
+@itemize
 @item
-* Check all 2ly scripts.
+write release notes.  note: stringent size requirements for
+various websites, so be brief.
 
 @item
-Run convert-ly on all files, bump parser minimum version.
+Run convert-ly on all files, bump parser minimum version.
 
 @item
-* 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
+Update lilypond.pot:
+
+@example
+make po-replace
+@end example
 
 @item
-* Make FTP directories on lilypond.org
+Make directories on lilypond.org:
+
+@example
+~/web/download/sources/v2.14
+~/web/download/sources/v2.15
+@end example
 
 @item
-* website:
-  - Make new table in download.html
+Shortly after the release, move all current contributors to
+previous contributors in:
+
+@example
+Documentation/included/authors.itexi
+@end example
 
-  - add to documentation list
+Also, delete old material in:
 
-  - revise examples tour.html/howto.html
+@example
+Documentation/changes.tely
+@end example
+
+but don't forget to check it still compiles!  also update the
+version numbers.
+
+@item
+Website:
 
-  - add to front-page quick links
+@itemize
+@item
+make a link from the old unstable to the next stable in
+lilypond.org's /doc/ dir.  Keep all previous unstable->stable doc
+symlinks.
 
-  - change all links to the stable documentation
+Also, make the old docs self-contained -- if there's a redirect in
+/doc/v2.12/Documentation/index.html , replace it with the
+index.html.old-2.12 files.
 
-  - make a link from the old unstable to the next stable in
-    lilypond.org's /doc/ dir.  Keep all previous unstable->stable
-    doc symlinks.
+The post-2.13 docs will need another way of handling the
+self-containment.  It won't be hard to whip up a python script
+that changes the link to ../../../../manuals.html to
+../website/manuals.html , but it's still a 30-minute task that
+needs to be done before 2.16.
 
-  - doc auto redirects  to v2.LATEST-STABLE
+@item
+doc auto redirects  to v2.LATEST-STABLE
 
-  - add these two lines to http://www.lilypond.org/robots.txt:
+@item
+add these two lines to http://www.lilypond.org/robots.txt:
 
 @example
 Disallow: /doc/v2.PREVIOUS-STABLE/
 Disallow: /doc/v2.CURRENT-DEVELOPMENT/
 @end example
 
-@item
-- check for emergencies the docs:
+@end itemize
 
-@example
-grep FIXME --exclude "misc/*" --exclude "*GNUmakefile" \
-  --exclude "snippets/*" ????*/*
-@end example
+@end itemize
+
+@subheading Unsorted
 
+@itemize
 @item
-- check for altered regtests, and document as necessary.  (update
-  tags as appropriate)
+submit po template for translation: send url of tarball to
+coordinator@@translationproject.org, mentioning lilypond-VERSION.pot
 
-@example
-git diff -u -r release/2.12.0-1 -r release/2.13.13-1 input/regression/
-@end example
+@item
+update links to distros providing lilypond packages?  link in:
+@file{Documentation/web/download.itexi}
 
+This has nothing to do with the release, but it's a "periodic
+maintenance" task that might make sense to include with releases.
 
 @item
+Send announcements to...
+
 News:
 
 @example
-        comp.music.research
-        comp.os.linux.announce
+comp.music.research
+comp.os.linux.announce
 
-        comp.text.tex
-        rec.music.compose
+comp.text.tex
+rec.music.compose
 @end example
 
-@item
 Mail:
 
 @example
-        info-lilypond@@gnu.org
+info-lilypond@@gnu.org
 
 linux-audio-announce@@lists.linuxaudio.org
 linux-audio-user@@lists.linuxaudio.org
 linux-audio-dev@@lists.linuxaudio.org
 
-        tex-music@@icking-music-archive.org
+tex-music@@icking-music-archive.org
 
-   --- non-existant?
-        abcusers@@blackmill.net
+--- non-existant?
+abcusers@@blackmill.net
 
-        rosegarden-user@@lists.sourceforge.net
-        info-gnu@@gnu.org
-        noteedit-user@@berlios.de
+rosegarden-user@@lists.sourceforge.net
+info-gnu@@gnu.org
+noteedit-user@@berlios.de
 
-        gmane.comp.audio.fomus.devel
-        gmane.linux.audio.users
-        gmane.linux.audio.announce
-        gmane.comp.audio.rosegarden.devel
+gmane.comp.audio.fomus.devel
+gmane.linux.audio.users
+gmane.linux.audio.announce
+gmane.comp.audio.rosegarden.devel
 @end example
 
-@item
 Web:
 
 @example
-        lilypond.org
-        freshmeat.net
-        linuxfr.com
-        http://www.apple.com/downloads
-        harmony-central.com (news@@harmony-central.com)
-        versiontracker.com [auto]
-        hitsquad.com [auto]
-        http://www.svgx.org
-        https://savannah.gnu.org/news/submit.php?group_id=1673  @c => planet.gnu.org
+lilypond.org
+freshmeat.net
+linuxfr.com
+http://www.apple.com/downloads
+harmony-central.com (news@@harmony-central.com)
+versiontracker.com [auto]
+hitsquad.com [auto]
+http://www.svgx.org
+https://savannah.gnu.org/news/submit.php?group_id=1673  @c => planet.gnu.org
 @end example
 
 @end itemize
@@ -417,7 +504,8 @@ 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'
+bin/gub --platform=darwin-x86 \
+  'git://git.sv.gnu.org/lilypond-doc.git?branch=stable/2.12'
 @end example
 
 or