TipFinal

Final Release

These instructions use outdated workflow based on svnmerge tool.

This flow takes the available changesets in checkpoint and brings release up to date. It assumes that checkpoint and release already exist and have been set up correctly. The trunk is the authoritative source for everything that goes in a release; only under exceptional circumstances are changes made to other branches. The general rule is that a change is made to trunk, brought over to checkpoint and then merged into release. This flow assumes that any needed changesets are already in checkpoint; if not, you will need to commit a suitable changeset to trunk following your usual development practices, then cherry-pick the changes into checkpoint before starting this flow. If you want a checklist you can mark off as you go, cut-n-paste these contents.

Table of Contents

[TOC]

Assumed Setup

These initializations are the conventions that will be used in the rest of this flow.

The location of the SCons Mercurial archive:

  $ export HG=https://bitbucket.org/scons/scons

The version string, which should look something like this:

$ VERSION=3.2.0.final.0

Check Out Release

From within your base directory, execute this command:

  $ hg clone $HG
  $ hg checkout tip
  $ hg purge

Merge Checkpoint into Release

$ cd release
$ svnmerge merge -b -S $SVN/checkpoint -f commit.txt

Resolve Conflicts

FIXME This segment is overkill for anyone who actually uses SVN. Cut it or drop it.

A conflict occurs when SVN tries to apply changes from the archive that overlap with other changes made locally. These are rare but can happen when cherry-picking applies changes out of order. In general, the correct approach is to use the text from the archive rather than the local version, but use your judgment when making the changes as there will be some cases where the original text (or even a merger of the two texts) is the correct choice as SVN is not always accurate when marking the conflicted regions.

Finding conflicts

To determine if there're conflicts, run this command:

  $ svn status
  ?      test/example.py.r4941
  ?      test/example.py.mine
  ?      test/example.py.r4649
  C      test/example.py
  ?      src/engine/SCons/CoreFile.py.r4941
  ?      src/engine/SCons/CoreFile.py.mine
  ?      src/engine/SCons/CoreFile.py.r4649
  C      src/engine/SCons/CoreFile.py
  $

Lines that begin with "C" identify a file that's conflicted. There are also a number of related files provided by SVN that can be used in the process of resolution, identified by lines that begin with "?". This is a simple resolution, so we won't use them.

Removing Conflicts

To remove the conflicts from a file, follow these steps:

Locate a conflict marker in the text. The center of each conflicted region is marked with "=======" so searching for a line with only that on it will get you to the right place.
The start of the region is marked with "<<<<<<< .mine" and contains the local text. Delete this text as well as the start and center markers.
The end of the region is marked with something that looks like ">>>>>>> .r54321" and contains the text from the SVN archive. Delete the end marker.
Repeat until there are no more conflict markers. To see how your updated file compares with the archive, run this command:

  $ svn diff test/example.py

If the changes aren't satisfactory, repeat the editing step.

Once the editing is done, use this command to tell SVN that the conflict has been resolved:

  $ svn resolved test/example.py

As a side-effect, resolving the conflict will remove the related files provided by SVN.

Repeat this section for each conflicted file.

Update Release Values

Verify that release_level in ReleaseConfig is being set to final.

$ python bin/update-release-info.py release

The ReleaseConfig file is where the "official" version number ($VERSION), the Python version floors, and other information about the release is recorded. This command takes the information in ReleaseConfig and inserts it in the necessary files.

Commit Release

Look at the log messages in commit.txt and create log.file that hits the highlights of the changes that have been incorporated. Much of the information should already be in src/Announce.txt, so it mostly involves copy-n-past from there. Cut it heavily to one or two lines per feature; the major use of this log is people who are scanning to see where a feature was added, and they will appreciate clarity and brevity. This is an example of what log.file might be like:

Rebased the release branch to r54321 of the checkpoint branch.
  -- The blah was updated to do foo
  -- Feature bar was added by John Doe
  -- Various typos

Commit the changes using the log message:

$ svn commit -F log.file Sending some/file Sending some/other/file Transmitting file data .. Committed revision 54321. $

Build Candidate Packages

Provided you have all of the necessary utilities installed, this should be a simple matter of:

  $ rm -rf build
  $ python bootstrap.py

Test the Candidate Packages

This script is kept in the distribution as bin/xxxxxxxxx:

$ set -e
$ python runtest.py -a

Make a copy of it and edit it based on the description below.

Regression Test

The first line of the script runs the regression test. The SCons BuildBot monitors this branch and probably started running regression tests as soon as you checked in the branch. If so, delete the first line of the script as the Build``Bot is more comprehensive that running the test on a single machine. You will need to keep an eye on the BuildBot display until all the slaves have finished.

Package Tests

The build step above not only builds the packages but also unpacks all of them into subdirectories so that you can run the test suite against the packaged goods. This is intended to catch packaging problems such as not adding a new module to the packaging MANIFEST list(s). The runtest.py script supports a -p option and arguments that run the SCons tests against the different unpacked directories.

Edit the script to include the tests you want to include. If you want to be complete, test all of the packages.

To be quicker but still reasonably thorough, test tar-gz and zip, one each of local- and src- (probably do -tar-gz for one and -zip for the other), and rpm.

For a quick-n-dirty test, just test tar-gz or zip, and maybe rpm. Since all of the different packages use the same lists as input, it's pretty unlikely that the tests will pass on one package and fail for another.

If any of the tests fail, fix the problem in trunk following your usual development practices, cherry-pick the changes into the checkpoint branch, and go back to merge the changeset(s) into the release branch.

Tag the Release

Verify that you have VERSION in your shell environment as described in the setup section above, then run this command:

  $ hg tag -m "Tagging $VERSION" $VERSION
  $ hg push

Archive Candidate Packages

Verify that you have SVN and VERSION in your shell environment as described in the setup section above, then run the bin/FillMeIn script:

set -e # stop on error rm -rf ARCHIVE svn co --depth=files $SVN/ARCHIVE mkdir ARCHIVE/scons-$VERSION cp build/dist/* ARCHIVE/scons-$VERSION svn add ARCHIVE/scons-$VERSION svn commit -m"Saving copy of $VERSION in archive" ARCHIVE rm -rf ARCHIVE

Update SourceForge

Upload packages

Verify that you have SVN and VERSION in your shell environment as described in the setup section above, then run the bin/scp-sourceforge script:

$ sh bin/scp-sourceforge sf_username

Mark packages with release notes

Navigate to the SourceForge File Manager page for SCons. If you're reading this from a printed copy rather than the wiki page and can't click on the link, follow these instructions:

Log in to your Source``Forge account
Click on Develop just under Forge in the Source``Forge banner.
Under My Projects, click on Develop next to the SCons project.
Click on Project Admin -> File Manager Open the scons, scons-src, and scons-local directories. Within each one, open the $VERSION folder. In the scons/$VERSION directory, select the RELEASE.txt file and mark mark it as the release notes in the popup that appears, then save.

If this is a final release of the production branch, select scons-$VERSION.win32.exe and mark it as the default selection for Windows, then select scons-$VERSION.tar.gz and mark it as the default for all other OSes.

In turn, select each of the files (other than the release notes file itself, which is automatically set) in all three folders (and the folders themselves) and specify that RELEASE.txt is to be the release note for that file. Because of the way the page refreshes after clicking Save, it seems to be easier to start at the bottom and work your way up.

FIXME: TEST THIS: You can do multiple releases quickly by opening the File Manager page multiple times in a separate tabs, but if you do, make sure to wait for the page to reload completely in one tab before clicking Save in another. Trying to update multiple releases at once doesn't work, presumably because the session can only handle one update at a time.

Hide previous releases

For a checkpoint release, hide all checkpoints in the same series that are older than this checkpoint.
For a minor or micro release, hide all the checkpoint releases leading up to this release.
For a major release, hide all the checkpoint releases leading up this release AND hide all major and minor releases older than this release. For each release name you wish to hide, you have to do the following in scons, scons-local, and scons-src:
Click on the gear icon to the left of the package name and select Cut from the popup.
Click on the gear icon to the left of old checkpoints and select Paste from the popup. Test downloading

Navigate to the SCons download page. If you're reading this from a printed copy rather than the wiki page and can't click on the link, follow these instructions:

FIXME Add instructions if can't click. For each of the scons, scons-src, and scons-local directories:
Open the directory.
Open the $VERSION folder within the directory.
For each package in the folder, click on the link to download it.
Verify that the files arrived and look reasonable. Add news item

Navigate to the Project News page. If you're reading this from a printed copy rather than the wiki page and can't click on the link, follow these instructions:

FIXME These aren't complete.
Go to the Project Admin -> Feature Settings page
In Project News, click Submit. Once you get to the Project News page:
Fill in the Subject: box with something like "Release $VERSION now available"
Cut-and-paste the blurb you prepared above into the Details: box
Click Submit

Update scons.org

Update the scons.org Web Site

Apply changes to web site

Commit the changes you prepared above:

  $ svn commit -m"Changes to publish the SCons $VERSION release"

Now you have to go update the site:

  $ ssh -l scons manam.pair.com
  $ cd public_html
  $ cp -al production new  # hard-link the whole tree; fast.
  $ (cd new && svn up)     # should be fast here too
  $ rm -rf previous
  $ mv production previous && mv new production
  $ exit

Now point your browser to the SCons home page. If anything is amiss, fix it, commit the necessary changes, and update the site.

Test downloading

Navigate to the SCons download page.
Verify that the opening paragraph makes sense.
In the right-hand sidebar, find the download section corresponding to $VERSION.
For each file in the section, click on the link to download it.
Verify that the files arrived and look reasonable.

Update Tigris.org

Update project pages

Send the changes you prepared above to Tigris:

From within the www subdirectory of your trunk directory:

$ svn commit -m"Update project web pages for $VERSION"

Point your browser at the roadmap page; if anything's amiss, fix it and commit again.

Add news item

Log in to your tigris.org account
Click Announcements in the left-hand nav bar
Click Add new announcement
Double-check the date (it's probably already set)
Fill in the Headline box
Fill in the Body box with the HTML blurb
Click Add new announcement Add release name to issue tracker
Click Issue Tracker on the left-hand nav bar
Click Configuration options
Click Add/edit components
Under scons, to the far right of Add ..., click Version
At the bottom of the list, to the right of "Add a new version", click Add
Fill in the Version: box with the release ($VERSION)
Click the Add button

Announce

Prepare a blurb by starting with a copy of src/Announce.txt. Edit the file and follow these guidelines:

If the "scheduled for the next release" section has no content, cut it.
Keep the first "changes since release" section (which should be since the last production release).
Cut all of the subsequent "changes since release" sections.
Leave the copyright notice at the bottom. In general, use your own judgment as to what to keep and what to cut.

Post Blurb on Fresh``Meat

HOW? If you know how to do this, UPDATE THIS INFORMATION.

Send Blurb to Other Interested Parties

Debian maintainer?
Fedora maintainer?
Ubuntu maintainer?
Red``Hat maintainer? OTHERS? Are there other individuals we should notify? Or other mailing lists? If you know of any, UPDATE THIS INFORMATION.

See http://en.wikipedia.org/wiki/Linux_distributions and http://en.wikipedia.org/wiki/DistroWatch for candidates to be contacted.

Send blurb to SCons mailing lists

Send the blurb to each of these mailing lists individually with a title something like "SCons release $VERSION is now available".

Update Trunk to Next Version

Initialize files for next version

From within your base directory, execute this command:

$ svn co $SVN/trunk

From within the trunk directory, edit ReleaseConfig and change the assignment of release_level to 'post'.