iSharkFly-Open
/
python-peps
mirror of https://github.com/python/peps.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updates based on final decision about the inclusion of Doc/ in the 

source tarball (we do it), a compromise on when the branch is created,
and some information about the Mac.

Also, added some underlines for actual tick marks.
This commit is contained in:
Barry Warsaw 2001-10-24 23:18:46 +00:00
parent 831df0919f
commit 0087381033
1 changed files with 146 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

242
pep-0101.txt
View File

@ -16,7 +16,9 @@ Abstract
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.
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
@ -27,8 +29,8 @@ How to Make A Release
usually performed by An Expert, the name of that expert is given.
Otherwise, assume the step is done by the Release Manager (RM),
the designated person performing the release. Almost every place
the RM is mentioned below, this step can also be done by Guido,
naturally!
the RM is mentioned below, this step can also be done by the BDFL
of course!
XXX: We should include a dependency graph to illustrate the steps
that can be taken in parallel, or those that depend on other
@ -40,35 +42,55 @@ How to Make A Release
release candidate, and "f" == final. If a micro release number is
used, then we'll say X.Y.MaZ.
- A day or two before the release, create a branch for X.YaZ.
___ At noon the day before the release, create a branch for X.YaZ.
All Python development happens on the trunk. A few days before
the release, the RM will create a branch for this release. Only
the RM is authorized to make commits to this branch, but
check ins can proceed as normal on the trunk. It is the
responsibility of the RM to decide on a case-by-case basis which
trunk modifications should be merged into the branch.
All Python development happens on the trunk. Making releases
from a branch allows development by the community to continue
without impacting what ends up in the release. There's a
natural tension here though: branching too soon causes headaches
when the branch has to be merged back into the trunk, while
branching too late can cause dependency problems with
documentation and Windows release steps.
The compromise is to create the branch at noon, local time, the
day before the release. This should give enough time to Fred to
make the documentation, then for Tim to create the Windows
installer, both of which need to happen before the release can
be announced. It's also short enough that hopefully not too
many trunk changes will need to be merged into the branch, or
vice versa.
Once the branch is made, only the RM or his appointed bots are
allowed to make commits to the branch. You can assume that Fred
is a bot for the Doc/ tree, Tim is a bot for the Windows stuff,
and Jack is a bot for Mac stuff.
Anyone can continue to make checkins on the trunk, but if such a
change should be merged into the branch, the committer must
indicate this in the checkin message. It is the responsibility
of the RM to decide on a case-by-case basis which trunk
modifications should be merged into the branch.
To create a branch the following steps are taken:
* Do a CVS update with the -A flag, e.g.
___ Do a CVS update with the -A flag, e.g.
% cvs update -A
* CVS tag the trunk with the symbolic name "rXYaZ-fork", e.g.
___ CVS tag the trunk with the symbolic name "rXYaZ-fork", e.g.
% cvs tag r22a3-fork
* Make the branch with the symbolic name "rXYaZ-branch", e.g.
___ Make the branch with the symbolic name "rXYaZ-branch", e.g.
% cvs tag -b r22a3-branch
* Check out a clean version of the branch into a new directory.
___ 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.
% cvs -d <cvsroot> -q co -d python-22a3 -r r22a3-branch python/dist/src
- Send an email to python-dev@python.org indicating the fork and
___ Send an email to python-dev@python.org indicating the fork and
branch tags you've just created.
- Put a freeze on check ins into the branch. At this point,
___ Put a freeze on check ins into the branch. At this point,
nobody except the RM should make any commits to the branch (or
his duly assigned agents, i.e. Guido the BDFL, Fred Drake for
documentation, or Tim Peters for Windows). If the RM screwed up
@ -76,15 +98,19 @@ How to Make A Release
necessary, it can mean extra work for Fred and Tim. So try to
avoid this!
- In the branch, change Include/patchlevel.h in two places, to
___ In the branch, 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.
- For the next few days, selectively merge stuff from trunk into
branch. For each change you see on the trunk (i.e. via the
python-checkins mailing list), you need to decide whether the
change should also be applied to the branch.
___ For the next approximately 20 hours or so, selectively merge
stuff from trunk into branch. For each change you see on the
trunk (i.e. via the python-checkins mailing list), you need to
decide whether the change should also be applied to the branch.
Note that committers of changes to the trunk SHOULD include a
in the checkin message, a note indicating the suitability of
their patch for the branch.
If so, it's fairly easy to apply the change by diff'ing the file
and patching it manually. You can also sometimes get away with
@ -92,8 +118,13 @@ How to Make A Release
directory, but be careful so you don't lose changes that only
exist in the branch!
- The night before the release, the RM updates the Misc/NEWS file,
adding high level items new to this release. E.g. if we're
___ After creating the branch, the most important thing to do next
is to update the Misc/NEWS file. Tim will need this in order to
do the Windows release and he likes to stay up late. This step
can be pretty tedious, so it's best to get to it immediately
after making the branch.
Add high level items new to this release. E.g. if we're
releasing 2.2a3, there must be a section at the top of the file
explaining "What's new in Python 2.2a3". It will be followed by
a section entitled "What's new in Python 2.2a2".
@ -104,7 +135,7 @@ How to Make A Release
verify with Tim Peters about changes on Windows, and Jack Jansen
about changes on the Mac.
- Once the branch is frozen, Fred Drake needs to create the HTML
___ Once the branch is frozen, Fred Drake needs to create the HTML
from the documentation. He does this and uploads the file to
www.python.org. Then he tells Tim Peters where this file is.
This may generate some last minute changes on the branch. Once
@ -113,7 +144,12 @@ How to Make A Release
Fred also sends email to Milan Zamazal for conversion to the GNU
Info format.
- Tim Peters grabs the HTML and uses this to build the Windows
Note that Fred is responsible both for merging doc changes from
the trunk to the branch AND for merging any branch changes from
the branch to the trunk during the cleaning up phase.
Basically, if it's in Doc/ Fred will take care of it.
___ Tim Peters grabs the HTML and uses this to build the Windows
installer. Tim then creates a new "release" named X.YaZ on the
SourceForge file release manager.
@ -129,55 +165,54 @@ How to Make A Release
will create a new package containing the major Python version
number.
- Tim performs his Windows magic, generating an installer
___ Tim performs his Windows magic, generating an installer
executable. He uploads this file to SourceForge under the
release he just created. He then sends the RM a notice which
includes the MD5 checksum of the Windows executable.
Note that Tim's creation of the Windows executable may generate
a few more commits on the branch.
a few more commits on the branch. Tim will be responsible for
merging Windows-specific changes from trunk to branch, and from
branch to trunk.
- Now, you're ready to build the source tarball. First cd to your
___ It's Noon!
Now, you're ready to build the source tarball. First cd to your
working directory for the branch. E.g.
% cd .../python-22a3
- Do a "cvs update" in this directory. You should not see any "M"
files, but you may see several "P" files. I.e. you better not
have any uncommitted changes in your working directory, but you
may pick up some of Fred's or Tim's last minute changes.
___ Do a "cvs update" in this directory. Do NOT include the -A flag!
- Now tag the branch using a symbolic name like "rXYaZ",
You should not see any "M" files, but you may see several "P"
files. I.e. you better not have any uncommitted changes in your
working directory, but you may pick up some of Fred's or Tim's
last minute changes.
___ Now tag the branch using a symbolic name like "rXYaZ",
e.g. r22a3
% cvs tag r22a3
- Change to a neutral directory, i.e. one in which you can do a
fresh, virgin, export of the branch. You will be creating a new
directory at this location, to be named "Python-X.YaZ". Do a
CVS export of the tagged branch.
___ Change to a neutral directory, i.e. one in which you can do a
fresh, virgin, cvs export of the branch. You will be creating a
new directory at this location, to be named "Python-X.YaZ". Do
a CVS export of the tagged branch.
% cd ~
% cvs -d <cvsroot> export -rr22a3 -d Python-2.2a3 python/dist/src
- Remove the documentation sources from the export; these are only
useful to people who have LaTeX and possibly several other tools
installed (how many tools are required depends on the
documentation format you want to end up with). These also add
substantially to the size of the resulting archive (almost a
megabyte for Python 2.2).
% rm -r Python-.2a3/Doc/
- Generate the tarball. Note that we're not using the `z' option
___ Generate the tarball. 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.2a2 | gzip -9 > Python-2.2a2.tgz
- Calculate the MD5 checksum of the tgz file you just created
___ Calculate the MD5 checksum of the tgz file you just created
% md5sum Python-2.2a2.tgz
Note that if you don't have the md5sum program, there is a
Python replacement in the Tools/scripts/md5sum.py file.
- Now you want to perform the very important step of checking the
___ Now you want to perform the very important step of checking the
tarball you just created, to make sure a completely clean,
virgin build passes the regression test. Here are the best
steps to take:
@ -193,11 +228,11 @@ How to Make A Release
(Do all the expected tests pass?)
If the tests pass, then you can feel good that the tarball is
fine. If some of the tests pass, or anything else about the
fine. If some of the tests fail, or anything else about the
freshly unpacked directory looks weird, you better stop now and
figure out what the problem is.
- Start your upload to SF. You need to get Python-2.2a3.tgz into
___ Start your upload to SF. You need to get Python-2.2a3.tgz into
SourceForge. This can take a while both because of the time it
takes to upload such a huge file, /and/ because SF has a 30
minute delay built into the file release process. The next few
@ -207,13 +242,13 @@ How to Make A Release
I've found that the `ncftpput' program is a great tool to use if
you have it available. You can execute the following command to
do the upload:
% ncftpput -F upload.sf.net incoming Python-2.2a3.tgz
% ncftpput upload.sf.net incoming Python-2.2a3.tgz
If you don't have ncftpput around, you can use whatever ftp
client you're comfortable with. Just be sure that you're
uploading this to the "incoming" directory on upload.sf.net.
- You also need to upload the tgz file to creosote.python.org.
___ You also need to upload the tgz file to creosote.python.org.
Usually Tim will have already uploaded the exe file to creosote,
but if not, you'll need to do that too. These steps can take a
long time depending on your network bandwidth. You have two
@ -229,16 +264,18 @@ How to Make A Release
avoid the 30 minute SF delay. Cons: you don't get much else
done if you're on a small pipe.
- While you're waiting, you can start twiddling the web pages to
I usually opt for #2.
___ While you're waiting, you can start twiddling the web pages to
include the announcement.
* In the python.org web site CVS tree, cd to the X.Y
___ In the python.org web site CVS tree, cd to the X.Y
subdirectory, and copy index.ht to new-index.ht
% cd .../pydotorg/2.2
% cp index.ht new-index.ht
* Edit the file for content: usually you can globally replace
___ 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. You also need to watch out about two
specific links in the file, one which references "the full
@ -247,59 +284,59 @@ How to Make A Release
be able to update either link until you've completed the steps
below. For now just note what needs to change.
Also, update the MD5 checksums.
___ Also, update the MD5 checksums.
* Preview the web page by doing a "make" -- NOT a "make install".
___ 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
___ 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!
- Now we're waiting for the ncftpput command, and the scp to
___ Now we're waiting for the ncftpput command, and the scp to
creosote to finish. Da de da, da de dum, hmm, hmm, dum de dum.
- Do the SourceForge file release dance.
___ Do the SourceForge file release dance.
* Go to the Python project and click on "Admin"
* Click on "Edit/Release Files"
* Since Tim has usually by now created the package and release
___ Go to the Python project and click on "Admin"
___ Click on "Edit/Release Files"
___ Since Tim has usually by now created the package and release
we're going to use, scroll down and click on "Edit Releases"
for the package we're releasing into.
* Find the release named X.YaZ and click on "Edit This Release"
___ Find the release named X.YaZ and click on "Edit This Release"
You should now perform Step 1 of the file release dance...
* The "Status" field should be "Active" not "Hidden"
* In the text box that says "Paste The Notes In", paste in all
___ The "Status" field should be "Active" not "Hidden"
___ In the text box that says "Paste The Notes In", paste in all
the "What's New" entries from the Misc/NEWS file that describe
this major version of Python, /not/ just the ones for this
particular release. E.g. If we're releasing Python 2.2a3,
we'd include the "What's New" sections for Python 2.2a3,
2.2a2, and 2.2a1.
* Leave the "Paste The Change Log In" section blank, but click
___ Leave the "Paste The Change Log In" section blank, but click
on "Preserve my pre-formatted text".
* Hit the Submit/Refresh button for Step 1.
___ Hit the Submit/Refresh button for Step 1.
This will bring you back to the file release page. DO NOT do
the following step until your ftp upload is complete! Once it
is, you can perform Step 2 of the file release dance...
* Click on the checkbox next to the file Python-X.YaZ.tgz. Be
___ Click on the checkbox next to the file Python-X.YaZ.tgz. Be
sure no other box is checked! Then click on the "Add Files
and/or Refresh View" button for Step 2.
And now, Step 3...
* There should be exactly two files listed here, one is the tgz
___ There should be exactly two files listed here, one is the tgz
file you just added, and the other is the exe file that Tim
added earlier.
* For the tgz file, be sure that the "Processor" field says
___ For the tgz file, be sure that the "Processor" field says
"Any" and the "File Type" field says "Source .gz".
* Click on "Update/Refresh" for the .tgz file.
* For the exe file, make sure that the "Processor" field says
___ Click on "Update/Refresh" for the .tgz file.
___ For the exe file, make sure that the "Processor" field says
"i386" and the "File Type" field says "Other". Tim usually
gets this right <wink>, but if not, make any necessary changes
and click on "Update/Refresh" for the exe file.
@ -309,7 +346,7 @@ How to Make A Release
DO NOT DO STEP 4 NOW. Wait until after you send out the email
announcement to send the SF email notice.
- Still on SF, click on the "Files" button at the top of the
___ Still on SF, click on the "Files" button at the top of the
page. Find the release you've just made and click on it -- not
on the tgz or exe file, but on the release link under the
package name. E.g. package named python-2.2, click on the
@ -321,7 +358,7 @@ How to Make A Release
pydotorg/X.Y/new-index.ht file you created above. This is the
"shownotes" link mentioned earlier.
- Now click on the "Summary" link at the top of the page and
___ Now click on the "Summary" link at the top of the page and
scroll down to the "Latest File Releases" section. Find the
package you just made a release for (the Version should be
X.YaZ, and the Date should be today's date). Click on the
@ -332,7 +369,7 @@ How to Make A Release
pydotorg/X.Y/new-index.ht file from above. This is the
"showfiles" link mentioned earlier.
- Now you need to go to creosote.python.org and move all the files
___ Now you need to go to creosote.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"
@ -344,31 +381,31 @@ How to Make A Release
So...
* On creosote, cd to ~ftp/pub/python/X.Y creating it if
___ On creosote, cd to ~ftp/pub/python/X.Y creating it if
necessary.
* Move the previous release files to a directory called "prev"
___ 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.
* Move the .tgz file and the .exe file to this directory. Make
___ Move the .tgz file and the .exe file to this directory. Make
sure they are world readable. They should also be group
writable, and group-owned by webmaster.
- Update the X.Y/bugs.ht file if necessary. You may need to get
___ Update the X.Y/bugs.ht file if necessary. It is best to get
BDFL input for this step.
- Now preview the new-index.ht file once more. IMPORTANT: follow
___ 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.
- If everything looks good, move new-index.ht to index.ht and do a
___ 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!
- Now it's time to write the announcement for the mailing lists.
___ 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 one of Guido's earlier announcements as a template, but
please edit it for content!
@ -380,60 +417,60 @@ How to Make A Release
python-announce@python.org
python-dev@python.org
- Go back to the file releases page on SF and complete Step 4,
___ Go back to the file releases page on SF and complete Step 4,
sending out the email notification.
Now it's time to do some cleanup. These steps are very important!
- Go back to SF, Admin->Edit/Release Files. Click on "Edit
___ Go back to SF, Admin->Edit/Release Files. Click on "Edit
Releases" for the package you just added to. For each old
release, click on "Edit This Release" and under Step 1, change
the "Status" to "Hidden". Click on the Step 1 Submit/Refresh
button.
- Merge the branch back into the trunk! Now that we've released
___ Merge the branch back 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.
* Check out a completely clean, virgin working directory of the
___ 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:
% cvs -d <cvsroot> co -d python-clean python/dist/src
* Run a diff against your branch by doing this in the common
___ 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-22a2 | grep ^diff | grep -v CVS
* Take the output of this and stick it in a file,
___ Take the output of this and stick it in a file,
e.g. /tmp/diffcmd.sh
* Edit diffcmd.sh to get rid of files that you know don't have
___ 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. 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
___ 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
___ 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
___ 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 "cvs commit". Use as your log
___ cd to python-clean and do a "cvs commit". Use as your log
message something like "Merging the rXYaZ-branch tag back into
the trunk".
* Edit the file Include/patchlevel.h so that the PY_VERSION
___ 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:
@ -443,7 +480,13 @@ How to Make A Release
Make sure that the other PY_ version macros contain the
correct values. Commit this change.
* Now test your clean, merged trunk by doing
___ For the extra paranoid, do a completely clean test of the
release. This includes downloading the tarball from either
SourceForge or www.python.org.
___ Make sure the md5 checksums match. Then unpack the tarball,
and do a clean make test.
% make distclean
% ./configure
% make test
@ -469,6 +512,13 @@ What Next?
You've just made a Python release!
Actually, there is one more step. You should turn over ownership
of the branch to Jack Jansen. All this means is that now he will
be responsible for making commits to the branch. He's going to
use this to build the MacOS versions. He may send you information
about the Mac release that should be merged into the informational
pages on SourceForge or www.python.org.
Windows Notes