[Python-checkins] r62910 - in peps/trunk: pep-0101.txt pep-0361.txt
barry.warsaw
python-checkins at python.org
Fri May 9 01:52:57 CEST 2008
Author: barry.warsaw
Date: Fri May 9 01:52:56 2008
New Revision: 62910
Log:
Major updates to PEP 101 -- I actually took notes this time!
Python 2.6a3 and 3.0a5 are released today.
Modified:
peps/trunk/pep-0101.txt
peps/trunk/pep-0361.txt
Modified: peps/trunk/pep-0101.txt
==============================================================================
--- peps/trunk/pep-0101.txt (original)
+++ peps/trunk/pep-0101.txt Fri May 9 01:52:56 2008
@@ -11,14 +11,18 @@
Abstract
- Making a Python release is an arduous process that takes a
- minimum of half a day's work even for an experienced releaser.
- Until recently, most -- if not all -- of that burden was borne by
- Guido himself. But several recent releases have been performed by
- other folks, so this PEP attempts to collect, in one place, all
- the steps needed to make a Python release. It is organized as a
- recipe and you can actually print this out and check items off as
- you complete them.
+ Making a Python release is a thrilling and crazy process. You've heard
+ the expression "herding cats"? Imagine trying to also saddle those
+ purring little creatures up, and ride them into town, with some of their
+ buddies firmly attached to your bare back, anchored by newly sharpened
+ claws. At least they're cute, you remind yourself.
+
+ Actually, no that's a slight <wink> exaggeration. The Python release
+ process has steadily improved over the years and now, with the help of our
+ amazing community, is really not to difficult. This PEP attempts to
+ collect, in one place, all the steps needed to make a Python release. It
+ is organized as a recipe and you can actually print this out and check
+ items off as you complete them.
How to Make A Release
@@ -29,8 +33,9 @@
usually performed by An Expert, the role of that expert is given.
Otherwise, assume the step is done by the Release Manager (RM),
the designated person performing the release. The roles and their
- current experts are:
+ current experts are:
+ * RM = Release Manager: Barry Warsaw
* WE = Windows: Martin von Loewis
* ME = Mac: Ronald Oussoren
* DE = Documentation: Fred Drake
@@ -39,6 +44,12 @@
that can be taken in parallel, or those that depend on other
steps.
+ As much as possible, the release steps are automated and guided by the
+ release script, which is available in the Python sandbox. The release
+ script is currently being maintained by the RM:
+
+ http://svn.python.org/view/sandbox/trunk/release/
+
We use the following conventions in the examples below. Where a
release number is given, it is of the form X.YaZ, e.g. 2.6a3 for
Python 2.6 alpha 3, where "a" == alpha, "b" == beta, "c" ==
@@ -50,194 +61,147 @@
"releaseXY-fork". If a micro release number is used, then we'll
say X.Y.MaZ.
- Note: This document has been updated to reflect the more
- streamlined procedures used to release Python 2.6 (including the
- alphas and betas).
-
- We recommend that you use the release tool, from
-
- http://svn.python.org/projects/sandbox/trunk/release/
-
This helps by performing several automatic editing steps, and guides you
to perform some manual editing steps.
___ Impose a check-in freeze. Send a message to
- python-dev at python.org telling people not to make any check-ins
- on the tree until further notice.
+ python-dev at python.org (Py3: and python-3000 at python.org) telling people
+ not to make any check-ins on the tree until further notice.
- At this point, nobody except the RM or his duly assigned agents
- should make any commits to the branch. The assigned agents are
- either from the list above or by coordination as necessary. If
- a checkin needs to made, make sure to state in the checkin
- comment that the change was approved. If the RM screwed up and
- some desperate last minute change to the branch is necessary, it
- can mean extra work for others. So try to avoid this!
+ At this point, nobody except the RM or his duly assigned agents should
+ make any commits to the branches. The assigned agents are either from
+ the list above or by coordination as necessary. If a checkin needs to
+ be made, make sure to state in the checkin comment that the change was
+ approved. If the RM screwed up and some desperate last minute change to
+ the branch is necessary, it can mean extra work for others. So try to
+ avoid this!
+
+ The RM has full authority to revert any unapproved commits.
___ Log into irc.freenode.net and join the #python-dev channel.
You probably need to coordinate with other people around the
world. This IRC channel is where we've arranged to meet.
- ___ The most important thing to do is to update the Misc/NEWS file.
- This step can be pretty tedious, so it's best to get to it
- immediately after making the branch, or even before you've made
- the branch.
-
- Add high level items new to this release. E.g. if we're releasing
- 2.6a3, there must be a section at the top of the file explaining
- "What's new in Python 2.6 alpha 3". It will be followed by a
- section entitled "What's new in Python 2.6 alpha 2".
-
- Note that you /hope/ that as developers add new features to the
- trunk, they've updated the NEWS file accordingly. You can't be
- positive, so double check. It helps to verify with the Windows
- and Mac experts.
-
- This command should help you:
-
- % svn log -r '{YYYY-MM-DD}:HEAD' > /tmp/news.txt
-
- IOW, you're printing out all the svn log entries from the
- previous release date until now. You can then troll through the
- news.txt file looking for interesting things to add to NEWS.
-
- ___ For major releases (e.g. 2.6 final), move any historical "what's
- new" entries from Misc/NEWS to Misc/HISTORY.
-
- ___ Check with the IDLE maintainer to be sure that
- Lib/idlelib/NEWS.txt has been similarly updated.
-
- ___ Make sure the release date is fully spelled out in
- Doc/conf.py (setting 'today') (XXX update welease).
-
- ___ Tag and/or branch the tree for release X.YaZ (welease does tagging)
-
- If you're releasing an alpha/beta/release candidate, you will
- just tag the tree, AFTER you made the edits below. If you are
- releasing a final release, you will both tag the trunk and
- create the long-lived maintenance branch.
-
- All Python development happens on the trunk. While it's
- sometimes challenging to keep people from checking things in
- while you're making a release, it's still preferred to creating
- a short-lived release branch.
-
- Practically speaking, we tag and branch just before making the
- release. Branching too early causes too much merging work.
-
- When making a major release (e.g., for 2.6), you should branch.
- To create a _branch_ (e.g., release26-maint), do the following:
+ ___ Check to see if there are any showstopper bugs.
- ___ svn copy \
- svn+ssh://pythondev@svn.python.org/python/trunk \
- svn+ssh://pythondev@svn.python.org/python/branches/release26-maint
+ Go to http://bugs.python.org and look for any open bugs that can block
+ this release. You're looking at the Priority of the open bugs for the
+ release you're making; here are the relevant definitions:
- When making a minor release (e.g., for 2.6a1 or 2.6.1), you should tag.
- To create a _tag_ (e.g., r26a1), do the following:
+ release blocker - Stops the release dead in its tracks. You may not
+ make a release with any open blocker bugs.
- DO NOT TAG UNTIL YOU"VE MADE THE NECESSARY EDITS BELOW
+ critical - Important bugs that may become blockers for the next
+ release. You can make alpha and beta releases with open critical
+ bugs, but you may not make a final release with open critical bugs.
- ___ svn copy \
- svn+ssh://pythondev@svn.python.org/python/branches/release26-maint \
- svn+ssh://pythondev@svn.python.org/python/tags/r26a1
+ Review the release blockers and either resolve them, bump them down to
+ critical, or stop the release and ask for community assistance. If
+ you're making a final release, do the same with any open crticial bugs.
- ___ Check out a clean version of the branch into a new directory.
- You'll be doing a lot of work in this directory and you want
- to keep it straight from your trunk working directory. E.g.
-
- % svn co \
- svn+ssh://pythondev@svn.python.org/python/branches/release26-maint
+ ___ Check the stable buildbots.
- ___ cd release26-maint # cd into the branch directory.
+ Go to http://www.python.org/dev/buildbot/stable/
- ___ Change Include/patchlevel.h in two places, to
- reflect the new version number you've just created. You'll want
- to change the PY_VERSION macro, and one or several of the
- version subpart macros just above PY_VERSION, as appropriate.
- (checked by welease)
+ (the trailing slash is required). Look at the buildbots for the release
+ you're making. Ignore any that are offline (or inform the community so
+ they can be restarted). If what remains are green buildbots, you're
+ good to go. If you have non-offline red buildbots, you may want to hold
+ up the release until they are fixed. Review the problems and use your
+ judgement, taking into account whether you are making an alpha, beta, or
+ final release.
- ___ IDLE maintains its own versioning and NEWS file (Lib/idlelib/NEWS.txt).
- There should be a number of entries reflecting new development, under a
- temporary header. Update that header to reflect IDLE's new version and
- release date. Then update Lib/idlelib/idlever.py to show a matching
- version. (checked by welease)
+ ___ Bump version numbers via the release script.
- ___ distutils also maintains its own versioning file
- (Lib/distutils/__init__.py). Update this file with the Python version.
+ .../sandbox/release/release.py --bump X.YaZ
- ___ Change the "%define version" line of Misc/RPM/python-X.Y.spec to
- the same string as PY_VERSION was changed to above. E.g.
+ This automates updating various release numbers, but you will have to
+ modify a few files manually. If your $EDITOR environment variable is
+ set up correctly, release.py will pop up editor windows with the files
+ you need to edit.
- %define version 2.6a1
+ Most importantly is to update the Misc/NEWS file, however in recent
+ years, this has become easier as the community is responsible for most
+ of the content of this file. You should only need to review the text
+ for sanity, and update the release date with today's date.
- The following line, "%define libvers", should reflect the
- major/minor number as one would usually see in the
- "/usr/lib/python<libvers>" directory name. E.g.
+ If the minor (middle) digit of the version number changes, you will be
+ prompted to update some additional files:
- %define libvers 2.6
+ ___ The LICENSE file. Add the pending version to the list of releases,
+ and be sure to check the release dates.
- You also probably want to reset the %define release line
- to '1pydotorg' if it's not already that.
+ ___ There's a copy of the license in Doc/license.rst; the DE usually
+ takes care of that, but it's good to double check this.
- If the new release uses a major/minor version which is
- different than is in the name of the current
- "Misc/RPM/python-*.spec" file, rename the file:
+ ___ Doc/tutorial/interpreter.rst (3 references to '[Pp]ython26', one
+ to 'Python 2.6').
- % svn rename python-2.5.spec python-2.6.spec
- % svn commit
+ ___ Doc/tutorial/stdlib.rst and Doc/tutorial/stdlib2.rst, which have
+ each one reference to '[Pp]ython26'.
- ___ If this is a release candidate, mail Sean <jafo at tummy.com>
- noting the impending release, so that RPMs can be built and
- tested.
-
- ___ Update the README file, which has a big banner at the top
- proclaiming its identity.
-
- ___ Also update the LICENSE file, adding the pending version to the
- list of releases.
-
- ___ There's a copy of the license in
- Doc/license.rst; the DE usually takes care of that.
+ ___ Check the years on the copyright notice. If the last release
+ was some time last year, add the current year to the copyright
+ notice in several places:
- ___ If the minor (middle) digit of the version number changes, update:
+ ___ README
+ ___ LICENSE (make sure to change on trunk and the branch)
+ ___ Python/getcopyright.c
+ ___ Doc/README.txt (at the end)
+ ___ Doc/copyright.rst
+ ___ Doc/license.rst
+ ___ PC/python_nt.rc sets up the DLL version resource for Windows
+ (displayed when you right-click on the DLL and select
+ Properties).
+ ___ The license.ht file for the distribution on the website
+ contains what purports to be an HTML-ized copy of the LICENSE
+ file from the distribution. BROKEN
- ___ Doc/tutorial/interpreter.rst (3 references to '[Pp]ython26', one
- to 'Python 2.6').
+ ___ For major releases (e.g. 2.6 final), move any historical "what's
+ new" entries from Misc/NEWS to Misc/HISTORY.
- ___ Doc/tutorial/stdlib.rst and Doc/tutorial/stdlib2.rst, which have
- each one reference to '[Pp]ython26'.
+ ___ Check with the IDLE maintainer to be sure that
+ Lib/idlelib/NEWS.txt has been similarly updated.
- ___ Check the years on the copyright notice. If the last release
- was some time last year, add the current year to the copyright
- notice in several places:
+ (XXX Who is the IE (i.e. Idle Expert)?
- ___ README
+ ___ For a final release, edit the first paragraph of
+ Doc/whatsnew/X.Y.rst to include the actual release date; e.g. "Python
+ 2.5 was released on August 1, 2003." There's no need to edit this for
+ alpha or beta releases. Note that Andrew Kuchling often takes care of
+ this.
+
+ ___ Tag and/or branch the tree for release X.YaZ
+
+ If you're releasing an alpha/beta/release candidate, you will just tag
+ the tree. If you are releasing a final release, you will both tag the
+ trunk and create the long-lived maintenance branch.
- ___ LICENSE (make sure to change on trunk and the branch)
+ .../sandbox/release/release.py --tag X.YaZ
- ___ Python/getcopyright.c
+ Practically speaking, we tag and branch just before making the
+ release. Branching too early causes too much merging work.
- ___ Doc/README.txt (at the end)
+ When making a major release (e.g., for 2.6), you should branch.
+ To create a _branch_ (e.g., release26-maint), do the following:
- ___ Doc/copyright.rst
+ .../sandbox/release/release.py --branch X.Y.Z
- ___ Doc/license.rst
+ ___ If you just made the release branch, check out a clean version
+ into a new directory. You'll be doing a lot of work in this
+ directory and you want to keep it straight from your trunk working
+ directory. E.g.
- ___ PC/python_nt.rc sets up the DLL version resource for Windows
- (displayed when you right-click on the DLL and select
- Properties).
+ % svn co \
+ svn+ssh://pythondev@svn.python.org/python/branches/release26-maint
- ___ The license.ht file for the distribution on the website
- contains what purports to be an HTML-ized copy of the LICENSE
- file from the distribution. BROKEN
+ ___ cd release26-maint # cd into the branch directory.
- ___ For a final release, edit the first paragraph of
- Doc/whatsnew/X.Y.rst to include the actual release date;
- e.g. "Python 2.5 was released on August 1, 2003."
- There's no need to edit this for alpha or beta releases. Note
- that Andrew Kuchling often takes care of this.
+ ___ XXX If this is a release candidate, mail Sean <jafo at tummy.com>
+ noting the impending release, so that RPMs can be built and tested.
- ___ At this point, the DE will create the formatted versions of the
+ ___ XXX At this point, the DE will create the formatted versions of the
documentation and push the appropriate files out to their FTP
locations on www.python.org. The HTML format is used to build
the HTML Help format for the Windows installer, but the RM
@@ -253,7 +217,7 @@
documentation packages:
$ make clean
- $ make distribution
+ $ make distribution
The packages in build/distribution can be installed on the
FTP server using commands like these:
@@ -263,7 +227,7 @@
$ ssh dinsdale.python.org mkdir $TARGET
$ scp build/distribution/* dinsdale.python.org:$TARGET
- ___ For final releases, publish the documentation on python.org.
+ ___ XXX For final releases, publish the documentation on python.org.
This must be done by someone with write access to the pydotorg
repository.
@@ -324,12 +288,12 @@
required actions are described in a separate step of this
checklist.
- ___ Ping Neal Norwitz (or anyone else with access to the PSF box
+ ___ XXX Ping Neal Norwitz (or anyone else with access to the PSF box
which runs the automated builds) to fix conflicts that arise
in the checked out working areas.
- ___ The WE builds the Windows helpfile, using (in Doc/) either
-
+ ___ XXX The WE builds the Windows helpfile, using (in Doc/) either
+
$ make htmlhelp (on Unix)
or
@@ -342,10 +306,10 @@
python26.chm file. He then copies the file into the Doc
directories of the build trees (once for each target architecture).
- ___ The WE then generates Windows installer files for each Windows
- target architecture (for Python 2.6, this means x86
+ ___ XXX The WE then generates Windows installer files for each Windows
+ target architecture (for Python 2.6, this means x86
and AMD64). He has one checkout tree per target architecture,
- and builds the pcbuild.sln project for the appropriate
+ and builds the pcbuild.sln project for the appropriate
architecture. He then edits Tools/msi/config.py to update
full_current_version, and runs msi.py with ActivePython 2.5.
For that to work, the following prerequisites must be met:
@@ -362,7 +326,7 @@
The WE checksums the files (*.msi and *.chm), uploads them to
some place in the net, and emails you the location and md5sums.
- ___ Sean Reifschneider grabs the HTML and uses this to build the
+ ___ XXX Sean Reifschneider grabs the HTML and uses this to build the
Linux RPMs. Sean performs his Red Hat magic, generating a set
of RPMs. He uploads these files to python.org. He then sends
the RM a notice which includes the location and MD5 checksum of
@@ -370,58 +334,25 @@
___ Time to build the source tarball. If you created a branch, be
sure to cd to your working directory for the branch. E.g.
- % cd .../python-26a3
- (supported by welease)
+
+ % cd .../python-26
___ Do a "svn update ; svn status" in this directory.
- You should not see any files. I.e. you better not have any
- uncommitted changes in your working directory, but you may pick
- up some of the expert's last minute changes.
- (checked by welease)
+ You should not see any files. I.e. you better not have any uncommitted
+ changes in your working directory, but you may pick up some of the
+ expert's last minute changes.
___ If you've seen updates to existing files, update the svn tag:
- % svn copy \
- svn+ssh://pythondev@svn.python.org/python/trunk \
- svn+ssh://pythondev@svn.python.org/python/tags/r26a3
-
- If you created a maintenance branch and you've changed any files
- since you branched, tag the tree -- in the branch -- now with
- something like
-
- % svn copy \
- svn+ssh://pythondev@svn.python.org/python/trunk \
- svn+ssh://pythondev@svn.python.org/python/tags/r26
-
- This is the tag you will use below.
- (supported by welease)
-
- ___ Change to a neutral directory, i.e. one in which you can do a
- fresh, virgin, svn export of the branch. You will be creating a
- new directory at this location, to be named "Python-X.YaZ". Export
- the tagged branch.
-
- % cd ~
- % svn export svn+ssh://pythondev@svn.python.org/python/tags/r26a1 Python-2.6c2
- (supported by welease)
-
- ___ Generate the tarballs. Note that we're not using the `z' option
- on the tar command because 1) that's only supported by GNU tar
- as far as we know, and 2) we're going to max out the compression
- level, which isn't a supported option.
-
- % tar cf - Python-2.6c2 | gzip -9 > Python-2.6c2.tgz
- % tar cf - Python-2.6c2 | bzip2 -9 > Python-2.6c2.tar.bz2
- (supported by welease)
+ .../sandbox/release/release.py --tag X.YaZ
- ___ Calculate the MD5 checksums of the files you just created
+ ___ Use the release script to create the gzip and bz2 tarballs, md5
+ checksums, and gpg signature files.
- % md5sum Python-2.6c2.tgz
- % md5sum Python-2.6c2.tar.bz2
+ .../sandbox/release/release.py --export X.YaZ
- Note that if you don't have the md5sum program, there is a
- Python replacement in the Tools/scripts/md5sum.py file.
+ This will leave all the relevant files in a subdirectory called 'dist'.
___ Now you want to perform the very important step of checking the
tarball you just created, to make sure a completely clean,
@@ -438,8 +369,8 @@
% make test
(Do all the expected tests pass?)
- If you're feeling lucky and have some time to kill, run the full
- test suite:
+ If you're feeling lucky and have some time to kill, or if you are making
+ a release candidate or final release, run the full test suite:
% make TESTOPTS='-u all' test
@@ -448,112 +379,129 @@
freshly unpacked directory looks weird, you better stop now and
figure out what the problem is.
- ___ Upload the tar files to dinsdale.python.org using scp.
+ ___ For the extra paranoid, do a completely clean test of the
+ release. This includes downloading the tarball from
+ www.python.org.
+
+ ___ Make sure the md5 checksums match. Then unpack the tarball,
+ and do a clean make test.
+
+ % make distclean
+ % ./configure
+ % make test
- # XXX(nnorwitz): this entire section dealing with the website is outdated.
- # The website uses SVN and the build process has changed.
- ___ While you're waiting, you can start twiddling the web pages to
- include the announcement.
-
- ___ If necessary, and if you have the right permissions (the
- python.org sysadmins must set this up for you), check out the
- web site tree by doing:
-
- % cvs -d :ext:<you>@dinsdale.python.org:/usr/local/cvsroot co pydotorg
-
- XXX: what's the svn equivalent?
-
- ___ In the python.org web site SVN tree, cd to the X.Y
- subdirectory, and copy index.ht to new-index.ht. Be sure to
- do a "svn update" first!
-
- % cd .../pydotorg
- % svn up
- % cd 2.6
- % cp index.ht new-index.ht
-
- ___ Edit the file for content: usually you can globally replace
- X.Ya(Z-1) with X.YaZ. However, you'll need to think about the
- "What's New?" section.
-
- ___ Copy the Misc/NEWS file to NEWS.txt in the X.Y directory for
- python.org; this contains the "full scoop" of changes to
- Python since the previous release for this version of Python.
-
- ___ Also, update the MD5 checksums.
-
- ___ Preview the web page by doing a "make" -- NOT a "make install".
- View the page via a file: url.
-
- ___ Similarly, edit the ../index.ht file, i.e. the python.org home
- page. In the Big Blue Announcement Block, move the paragraph
- for the new version up to the top and boldify the phrase
- "Python X.YaZ is out". Edit for content, and preview as
- above. Do NOT do a "make install" yet!
-
- ___ Also on the ../index.ht file (still the python.org home page),
- update the link information so that the release status is
- correct. Update the links in the left-hand navigation
- sidebar. Still do NOT do a "make install"!
+ To ensure that the regression test suite passes. If not, you
+ screwed up somewhere!
+
+ ___ Upload the tar files to dinsdale.python.org using scp.
___ Now we're waiting for the scp to dinsdale to finish. Da de da,
da de dum, hmm, hmm, dum de dum.
___ Now you need to go to dinsdale.python.org and move all the files
- in place over there. Our policy is that every Python version
- gets its own directory, but each directory may contain several
- releases. We keep all old releases, moving them into a "prev"
- subdirectory when we have a new release.
+ in place over there. Our policy is that every Python version gets its
+ own directory, but each directory may contain several releases. We keep
+ all old releases, moving them into a "prev" subdirectory when we have a
+ new release.
+
+ So, there's a directory called "2.6" which contains Python-2.5a2.exe and
+ Python-2.6a2.tgz, along with a "prev" subdirectory containing
+ Python-2.6a1.msi, Python-2.6a1.tgz, Python-2.6a1.tar.bz2, etc.
+
+ ___ On dinsdale, cd /data/ftp.python.org/pub/python/X.Y[.Z]
+ creating it if necessary.
- So, there's a directory called "2.6" which contains
- Python-2.5a2.exe and Python-2.6a2.tgz, along with a "prev"
- subdirectory containing Python-2.6a1.msi, Python-2.6a1.tgz,
- Python-2.6a1.tar.bz2, etc.
+ ___ Move the previous release files to a directory called 'prev'
+ creating the directory if necessary (make sure the directory has
+ g+ws bits on). If this is the first alpha release of a new Python
+ version, skip this step.
- So...
+ For pre-releases (alpha, beta, rc), don't move things into a 'prev'
+ directory, You'll move everything in there when the final release
+ comes out.
- ___ On dinsdale, cd /data/ftp.python.org/pub/python/X.Y[.Z]
- creating it if necessary.
+ ___ Move the .tgz, tar.bz2, and .msi files to this directory. Make
+ sure they are world readable. They should also be group writable,
+ and group-owned by webmaster.
- ___ Move the previous release files to a directory called "prev"
- creating the directory if necessary (make sure the directory
- has g+ws bits on). If this is the first alpha release of a
- new Python version, skip this step.
+ ___ md5sum the files and make sure they got uploaded intact.
- ___ Move the .tgz, tar.bz2, and .msi files to this directory. Make
- sure they are world readable. They should also be group
- writable, and group-owned by webmaster.
+ Now it's time to twiddle the web site.
- ___ md5sum the files and make sure they got uploaded intact.
+ To do these steps, you must have the permission to edit the website. If you
+ don't have that, ask someone on pydotorg at python.org for the proper
+ permissions. It's insane for you not to have it.
+ I'm not going to go into the details of building the site or pushing it
+ live. Plenty of people on pydotorg can help you, and there's a good README
+ once you get the branch. All the directories below are named relative to
+ the data subdirectory unless otherwise noted.
- ___ Update the X.Y/bugs.ht file if necessary.
+ This page will probably come in handy:
- ___ Now preview the new-index.ht file once more. IMPORTANT: follow
- every link on the page to make sure it goes where you expect it
- to go, and that what you expect to be there is there.
+ http://docutils.sourceforge.net/docs/user/rst/quickref.html
- ___ If everything looks good, move new-index.ht to index.ht and do a
- "make install" in this directory. Go up to the parent directory
- (i.e. the root of the web page hierarchy) and do a "make
- install" there too. You're release is now live!
+ None of the web site updates are automated by release.py.
- ___ Now it's time to write the announcement for the mailing lists.
- This is the fuzzy bit because not much can be automated. You
- can use an earlier announcement as a template, but edit it for content!
+ ___ Build the basic site.
- Once the announcement is ready, send it to the following
+ In the top directory, do an `svn update` to get the latest code. In the
+ build subdirectory, do `make` to build the site. Do `make serve` to
+ start service the pages on localhost:8005. Hit that url to see the site
+ as it is right now. At any time you can re-run `make` to update the
+ local site. You don't have to restart the server.
+
+ Don't `svn commit` until you're all done!
+
+ ___ If this is the first release for this version (even a new patch
+ version), you'll need to create a subdirectory inside download/releases
+ to hold the new version files. It's probably a good idea to copy an
+ existing recent directory and twiddle the files in there for the new
+ version number.
+
+ ___ Add a news section item to the front page by editing newsindex.yml. The
+ format should be pretty self evident.
+
+ ___ Edit download/releases/content.ht to update the version numbers for
+ this release. There are a bunch of places you need to touch:
+
+ ___ The subdirectory name as the first element in the Nav rows.
+ ___ Possibly the Releases section, and possibly in the experimental
+ releases section if this is an alpha, beta or release candidate.
+
+ ___ Update the version specific pages.
+
+ ___ cd to download/releases/X.Y.Z
+ ___ Edit the version numbers in content.ht
+ ___ Copy the new .asc files into place
+ ___ Update the md5 checksums
+
+ ___ Copy Misc/NEWS to download/releases/X.Y.Z/NEWS.txt
+ ___ Copy Lib/idlelib/NEWS.txt to download/releases/X.Y.Z/IDLENEWS.txt
+
+ Note, you don't have to copy the actual .tgz or tar.bz2 tarballs into
+ this directory because they only live on dinsdale in the ftp directory.
+
+ ___ When everything looks good, `svn commit` in the data directory. This
+ will trigger the live site to update itself, and at that point the
+ release is live.
+
+ Now it's time to write the announcement for the mailing lists. This is the
+ fuzzy bit because not much can be automated. You can use an earlier
+ announcement as a template, but edit it for content!
+
+ ___ Once the announcement is ready, send it to the following
addresses:
python-list at python.org
python-announce at python.org
python-dev at python.org
- ___ Mention the release as the most recent stable one in
+ ___ XXX Mention the release as the most recent stable one in
pydotorg:doc/faq/general.ht (section "How stable is
Python?")
- ___ Make the last change to the documentation area on
+ ___ XXX Make the last change to the documentation area on
python.org. (Remember those from the documentation items above?
It's time now.)
@@ -565,100 +513,82 @@
$ cd /data/ftp.python.org/pub/www.python.org/doc/
$ rm current && ln -s $VERSION current
- Now it's time to do some cleaning up. These steps are very important!
+ Now it's time to do some cleaning up. These steps are very important!
___ If you made a non-maintenance branch, be sure to merge it into
- the trunk! Now that we've released this branch, we don't need
- it any more. We've already tagged it so we can always reproduce
- it. Note that merging branches is a bit of a black art, but
- here's what's worked for us.
+ the trunk! Now that we've released this branch, we don't need it any
+ more. We've already tagged it so we can always reproduce it. Note that
+ merging branches is a bit of a black art, but here's what's worked for
+ us.
NOTE: If this was an X.Y major release, we will be using this as
the maintenance branch for a long time to come.
- ___ Check out a completely clean, virgin working directory of the
- trunk, by doing this in the directory that is the parent of
- your branch working directory python-XYaZ:
- % svn co \
- svn+ssh://pythondev@svn.python.org/python/trunk python-clean
-
- ___ Run a diff against your branch by doing this in the common
- parent directory containing both python-clean and python-XYaZ:
- % diff -r python-clean python-26a2 | grep ^diff | grep -v /.svn/ \
- > /tmp/diffcmd.sh
-
- ___ Edit diffcmd.sh to get rid of files that you know don't have
- important changes. You're looking for files that have updates
- in the branch that haven't made it to the trunk.
-
- Generally you can ignore any changes to the Doc or Mac
- subdirectories, or any changes to Windows related files. The
- sub-RMs for those parts will take care of any necessary merges
- from the branch to the trunk.
-
- If you've been diligent about merging changes from the trunk
- into the branch, there shouldn't be many of these files.
-
- ___ Edit /tmp/diffcmd.sh, changing all the -r's into -u's. Run
- the /tmp/diffcmd.sh command like so:
- % sh /tmp/diffcmd.sh > /tmp/pydiff.txt
-
- ___ Attempt to patch your python-clean working directory. Do this
- first, noting that --dry-run does not actually apply any
- patches, it just makes sure that the patch command runs
- successfully to completion:
- % patch -p1 --dry-run < /tmp/pydiff.txt
-
- ___ If this goes well, run it again, taking out the --dry-run
- option. If this fails, or if it prompts you for a file to
- patch, try using -p0 instead of -p1. Otherwise, your diff
- command was messed up, so try again.
-
- ___ cd to python-clean and do a "svn commit". Use as your log
- message something like "Merging the rXYaZ-maint tag back into
- the trunk".
-
- ___ Edit the file Include/patchlevel.h so that the PY_VERSION
- string says something like "X.YaZ+". Note the trailing `+'
- indicating that the trunk is going to be moving forward with
- development. E.g. the line should look like:
-
- #define PY_VERSION "2.6a2+"
-
- Make sure that the other PY_ version macros contain the
- correct values. Commit this change.
-
- ___ For the extra paranoid, do a completely clean test of the
- release. This includes downloading the tarball from
- www.python.org.
-
- ___ Make sure the md5 checksums match. Then unpack the tarball,
- and do a clean make test.
-
- % make distclean
- % ./configure
- % make test
-
- To ensure that the regression test suite passes. If not, you
- screwed up somewhere!
-
- Step 5 ...
-
- Verify! This can be interleaved with Step 4. Pretend you're a
- user: download the files from python.org, and make Python from it.
- This step is too easy to overlook, and on several occasions we've
- had useless release files. Once a general server problem caused
- mysterious corruption of all files; once the source tarball got
- built incorrectly; more than once the file upload process on SF
- truncated files; and so on.
+ ___ Check out a completely clean, virgin working directory of the
+ trunk, by doing this in the directory that is the parent of
+ your branch working directory python-XYaZ:
+ % svn co \
+ svn+ssh://pythondev@svn.python.org/python/trunk python-clean
+
+ ___ Run a diff against your branch by doing this in the common
+ parent directory containing both python-clean and python-XYaZ:
+ % diff -r python-clean python-26a2 | grep ^diff | grep -v /.svn/ \
+ > /tmp/diffcmd.sh
+
+ ___ Edit diffcmd.sh to get rid of files that you know don't have
+ important changes. You're looking for files that have updates
+ in the branch that haven't made it to the trunk.
+
+ Generally you can ignore any changes to the Doc or Mac
+ subdirectories, or any changes to Windows related files. The
+ sub-RMs for those parts will take care of any necessary merges
+ from the branch to the trunk.
+
+ If you've been diligent about merging changes from the trunk
+ into the branch, there shouldn't be many of these files.
+
+ ___ Edit /tmp/diffcmd.sh, changing all the -r's into -u's. Run
+ the /tmp/diffcmd.sh command like so:
+ % sh /tmp/diffcmd.sh > /tmp/pydiff.txt
+
+ ___ Attempt to patch your python-clean working directory. Do this
+ first, noting that --dry-run does not actually apply any
+ patches, it just makes sure that the patch command runs
+ successfully to completion:
+ % patch -p1 --dry-run < /tmp/pydiff.txt
+
+ ___ If this goes well, run it again, taking out the --dry-run
+ option. If this fails, or if it prompts you for a file to
+ patch, try using -p0 instead of -p1. Otherwise, your diff
+ command was messed up, so try again.
+
+ ___ cd to python-clean and do a "svn commit". Use as your log
+ message something like "Merging the rXYaZ-maint tag back into
+ the trunk".
+
+ ___ Do the guided post-release steps with the release script.
+
+ .../sandbox/release/release.py --done X.YaZ
+
+ Review and commit these changes.
+
+ ___ Send email to python-dev (Py3: and python-3000) informing them that the
+ branch has been unfrozen.
What Next?
- Rejoice. Drink. Be Merry. Write a PEP like this one. Or be
- like unto Guido and take A Vacation.
+ __ Verify! Pretend you're a user: download the files from python.org, and
+ make Python from it. This step is too easy to overlook, and on several
+ occasions we've had useless release files. Once a general server problem
+ caused mysterious corruption of all files; once the source tarball got
+ built incorrectly; more than once the file upload process on SF truncated
+ files; and so on.
+
+ __ Rejoice. Drink. Be Merry. Write a PEP like this one. Or be
+ like unto Guido and take A Vacation.
- You've just made a Python release!
+ You've just made a Python release!
Final Release Notes
Modified: peps/trunk/pep-0361.txt
==============================================================================
--- peps/trunk/pep-0361.txt (original)
+++ peps/trunk/pep-0361.txt Fri May 9 01:52:56 2008
@@ -53,7 +53,7 @@
Feb 29 2008: Python 2.6a1 and 3.0a3 are released
Apr 02 2008: Python 2.6a2 and 3.0a4 are released
- May 07 2008: Python 2.6a3 and 3.0a5 planned
+ May 08 2008: Python 2.6a3 and 3.0a5 are released
Jun 04 2008: Python 2.6b1 and 3.0b1 planned
Jul 02 2008: Python 2.6b2 and 3.0b2 planned
Aug 06 2008: Python 2.6rc1 and 3.0rc1 planned
More information about the Python-checkins
mailing list