Rev 3190: better docs on release process in file:///home/pqm/archives/thelove/bzr/%2Btrunk/

Canonical.com Patch Queue Manager pqm at pqm.ubuntu.com
Thu Jan 17 06:17:21 GMT 2008


At file:///home/pqm/archives/thelove/bzr/%2Btrunk/

------------------------------------------------------------
revno: 3190
revision-id:pqm at pqm.ubuntu.com-20080117061714-b11thhb6x5jbgwpl
parent: pqm at pqm.ubuntu.com-20080117035250-gbe1pe5e25m58t9q
parent: mbp at sourcefrog.net-20080116002625-c1hbpaxotm5be1rj
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Thu 2008-01-17 06:17:14 +0000
message:
  better docs on release process
modified:
  doc/developers/HACKING.txt     HACKING-20050805200004-2a5dc975d870f78c
    ------------------------------------------------------------
    revno: 3092.4.5
    revision-id:mbp at sourcefrog.net-20080116002625-c1hbpaxotm5be1rj
    parent: mbp at sourcefrog.net-20080104080642-0som1my1v6qnf3ti
    committer: Martin Pool <mbp at sourcefrog.net>
    branch nick: doc
    timestamp: Wed 2008-01-16 11:26:25 +1100
    message:
      Improved and reformatted developer documentation on the Bazaar release process.
    modified:
      doc/developers/HACKING.txt     HACKING-20050805200004-2a5dc975d870f78c
=== modified file 'doc/developers/HACKING.txt'
--- a/doc/developers/HACKING.txt	2008-01-04 08:06:42 +0000
+++ b/doc/developers/HACKING.txt	2008-01-16 00:26:25 +0000
@@ -1755,13 +1755,15 @@
 Starting a Release
 ------------------
 
-TODO: Things to cover:
-
-* RFI on release objectives
-* RFI on higher risk things that are best done early, e.g. changes to file
-  format defaults
-* Communication of proposed dates
-
+To start a new release cycle:
+
+#. Send mail to the list with the key dates, who will be the release
+   manager, and the main themes or targetted bugs.  Ask people to nominate
+   objectives, or point out an high-risk things that are best done early,
+   or that interact with other changes.
+
+#. Add a new "series" in Launchpad at <https://launchpad.net/bzr/+addseries>.  There is one 
+   series for every *x.y* release.
 
 Weekly Status Updates
 ---------------------
@@ -1790,6 +1792,8 @@
 .. TODO: Still needs more clarity on what's in a RC versus a final
 .. release?
 
+.. TODO: Too much of this is manual but could be automated...
+
 This is the procedure for making a new bzr release:
 
 #. If the release is the first candidate, make a new branch in PQM. (Contact RobertCollins for this step).
@@ -1862,12 +1866,42 @@
    
      cd /tmp && tar czf bzr-<version>.tar.gz bzr-<version>
 
-#. Sign the tarball with e.g. ``gpg --detach-sign bzr-0.10rc1.tar.gz``
-
-#. Upload to sftp://escudero.ubuntu.com/srv/bazaar.canonical.com/www/releases/src
-   or, add a download file in https://edge.launchpad.net/bzr/+download and use that address below...
-
-#. Link from http://bazaar-vcs.org/Download
+#. Sign the tarball with e.g. ``gpg --detach-sign -a bzr-0.10rc1.tar.gz``
+
+
+Publishing the release
+----------------------
+
+Now you have the releasable product.  The next step is making it
+available to the world.
+
+#. In <https://launchpad.net/bzr/> click the "Release series" for this
+   series, to take you to e.g. <https://launchpad.net/bzr/1.1>.  Then
+   click "Register a release", and add information about this release.
+
+#. Within that release, upload the source tarball and the GPG signature.
+
+   (These used to also be uploaded to 
+   <sftp://escudero.ubuntu.com/srv/bazaar.canonical.com/www/releases/src>
+   but that's not accessible to all developers, and gets some mime types
+   wrong...)
+
+#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
+
+#. Update http://doc.bazaar-vcs.org/ to have a directory of documentation
+   for this release.  (Controlled by the ``update-bzr-docs`` script on
+   escudero, and also update the ``latest`` symlink in
+   ``/srv/bazaar.canonical.com/doc/``.)
+
+#. Announce on the `Bazaar home page`__
+   
+ __ http://bazaar-vcs.org/
+
+
+Announcing the release
+----------------------
+
+Now that the release is publicly available, tell people about it.
 
 #. Announce to ``bazaar-announce`` and ``bazaar`` mailing lists. 
    The announce mail will look something like this:
@@ -1888,18 +1922,17 @@
     | Many thanks to all the contributors to this release! I've included the
     | contents of NEWS for VERSION below:
 
-To generate the data from NEWS, just copy and paste the relevant news section and clean it up as appropriate. The main clean-up task is to confirm that all major changes are indeed covered. This can be done by running ``bzr log`` back to the point when the branch was opened and cross checking the changes against the NEWS entries.
-
- * For point releases (i.e. a release candidate, or an incremental fix to a released version) take everything in the relevant NEWS secion : for 0.11rc2 take everything in NEWS from the bzr 0.11rc2 line to the bzr 0.11rc1 line further down.
- * For major releases (i.e. 0.11, 0.12 etc), take all the combined NEWS sections from within that version: for 0.11 take all of the 0.11 specific section, plus 0.11rc2, plus 0.11rc1 etc.
-
-#. Announce on the `Bazaar home page`__
-   
- __ http://bazaar-vcs.org/
+   To generate the data from NEWS, just copy and paste the relevant news section and clean it up as appropriate. The main clean-up task is to confirm that all major changes are indeed covered. This can be done by running ``bzr log`` back to the point when the branch was opened and cross checking the changes against the NEWS entries.
+
+   (RC announcements should remind plugin maintainers to update their plugins.)
+
+     * For point releases (i.e. a release candidate, or an incremental fix to a released version) take everything in the relevant NEWS secion : for 0.11rc2 take everything in NEWS from the bzr 0.11rc2 line to the bzr 0.11rc1 line further down.
+
+     * For major releases (i.e. 0.11, 0.12 etc), take all the combined NEWS sections from within that version: for 0.11 take all of the 0.11 specific section, plus 0.11rc2, plus 0.11rc1 etc.
 
 #. Update the `news side menu`__ -- this currently requires downloading the file, editing it, deleting it, and uploading a replacement.
 
- __ http://bazaar-vcs.org/site/menu?action=AttachFile&do=view&target=news.html
+   __ http://bazaar-vcs.org/site/menu?action=AttachFile&do=view&target=news.html
 
 #. Update the IRC channel topic. Use the ``/topic`` command to do this, ensuring the new topic text keeps the project name, web site link, etc.
 
@@ -1909,32 +1942,33 @@
 
 #. Update http://en.wikipedia.org/wiki/Bzr -- this should be done for final releases but not Release Candidates.
 
-#. Update https://launchpad.net/products/bzr/ -- add a release on the right series for the product.
-
-#. Update http://doc.bazaar-vcs.org/  
-
-   **TODO** Explain how.
-
 #. Package maintainers should update packages when they see the
    announcement.
 
-#. RC announcements should remind plugin maintainers to update their
-   plugins.
-
 #. Blog about it.
 
 #. Post to http://mail.python.org/mailman/listinfo/python-announce-list for major releases
 
-#. Update the python package index: http://pypi.python.org/pypi/bzr
+#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
+   done by running ::
+
+       python setup.py register
+
+   Remember to check the results afterwards.
 
 
 Making Win32 installers
 -----------------------
 
+**XXX:** This information is now probably obsolete, as Alexander uploads
+direct to Launchpad.  --mbp 20080116
+
 Alexander Belchenko has been very good about getting packaged installers compiled (see Win32ReleaseChecklist for details). He generally e-mails John Arbash Meinel when they are ready. This is just a brief checklist of what needs to be done.
 
 #. Download and verify the sha1 sums and gpg signatures. Frequently the sha1 files are in dos mode, and need to be converted to unix mode (strip off the trailing ``\r``) before they veryify correctly.
 
+#. Upload to the Launchpad page for this release.
+
 #. Upload to escudero (to the b.c.c/www/releases/win32 directory) using sftp, lftp or rsync
 
 #. Cat the contents of the .sha1 files into the SHA1SUM.




More information about the bazaar-commits mailing list