wiki:ReleaseProcedure

Version 66 (modified by Peter Johansson, 9 years ago) (diff)

--

Contents

  1. Publishing a release
    1. Minor release procedure
      1. Creating a release branch
      2. Rolling a minor release
    2. Patch release procedure

Publishing a release

These instructions cover how to release minor and patch releases in a project that uses trac/subversion for revision control and project management. How to release major releases is not covered yet since we have not done that (with the exception of the first release). Release numbering follows the normal convention of major.minor.patch and the APR (see http://apr.apache.org/versioning.html) guidelines for releases are used.

The main development is performed in the trunk branch of the repository. A new release branch is created for each minor release from the trunk and patch releases are snapshots of the minor release branch. This implies that patch work is performed in the minor release branch, and changes made release branch is transferred to the trunk every time a new patch release is made. Remember, patch work should be limited to bug fixes and important fixes only leaving development of new features and designs to the trunk branch.

Releases should only be performed by an appointed member of the team, the Release Manager, and merges should be performed by a Merge Manager. Of course, one team member can be both managers, thus becoming the Release and Merge Manager.

Minor release procedure

This section describes what to do when publishing a minor release.

Creating a release branch

Once people agree that a new release branch should be made, the Release Manager creates it with the following procedure (substitute A.B with the version you are preparing):

  1. Mark the new minor series in NEWS
    See the end for copyrights and conditions.
    
    +svndigest A.B.x series from 
    +          http://dev.thep/lu.se/svndigest/svn/branches/A.B-stable
    +
    Version A.B (released NOT YET)
    
    commit the changes with svn ci -m "preparing branch A.B-stable"

  2. Update copyright statements with commands
    make check && ./bin/svncopyright -v
    
    Examine the updates and commit changes with `svn ci -m "updating copyright statements"`

  3. Create a new minor branch using a one liner like
    svn copy ^/trunk ^/branches/A.B-stable -m "New minor version A.B branch"
    
  4. Check out a wc of the new branch
    svn co http://dev.thep.lu.se/svndigest/svn/branches/A.B-stable /path/to/svndigest-A.B.x 
    
  5. Due to ticket #463, remove test/testSubDir
    rm -rf /path/to/svndigest-trunk/test/testSubDir
    
  6. Copy the cache from wc of trunk to wc of new branch:
    svndigest-copy-cache -v -r /path/to/svndigest-trunk -t /path/to/svndigest-A.B.x
    
  7. Prepare the trunk for the next minor release

    1. Update version number in m4/version.m4. Locate and change the below lines
      m4_define([MINOR_VERSION], [B+1])
      
    2. Add an entry in NEWS
      version A.[B+1] (released NOT YET)
      
      The date is set when version A.[B+1] is released.

    3. Commit changes to the repository, svn ci -m "Bumping VERSION to A.[B+1]"

Rolling a minor release

  1. Make sure that all commits are performed into to the trunk, such as bumping version number(s) (version.m4), acknowledge contributions (THANKS), update file NEWS.

  2. Update version number in [source:trunk/m4/version.m4 version.m4]. Locate and change the below line
    m4_define([SVNDIGEST_DEV_BUILD], [false])
    
  3. Update THANKS.

  4. Set the date for the new release in NEWS
    version A.B (released 26 June 2007)
    
    Make sure that the items in NEWS cover the new features of the release.

  5. Commit changes to the repository
    svn ci -m "Preparing release A.B"
    
  6. Update copyright statements with commands
    make check && ./bin/svncopyright -v
    
    Examine the updates and commit changes with `svn ci -m "updating copyright statements"`

  7. Issue svn update to make entire wc to be in revision HEAD. Needless to say, make sure that the program is in a state to be released; make sure that all the tests pass, test the distribution package, and perform all other release tests you think is appropriate.

    Run
    make
    make release
    
    Fix potential problems.

  8. Check that you are synchronized with repository
    svn status -qu
    
    and then create a tag using a one liner like
    svn copy ^/branches/A.B-stable ^/tags/A.B -m "tagging version A.B"
    
  9. Upload svndigest-A.B.tar.gz and md5 file to sourceforge using scp like
    scp svndigest-A.B.tar.gz svndigest-A.B.tar.gz.MD5 USER,svndigest@frs.sourceforge.net:/home/frs/project/s/sv/svndigest/.
    
  10. Update SubversionCheckout and WikiStart

    1. Update the section Latest stable release to reflect the new version, that is

      • Change the version number

      • Update the package link to the new version

      • Update link to NEWS file to source:tags/A.B/NEWS

    2. In section svndigest latest release update link to [source:tags/A.B/NEWS NEWS] and modify the svn commands to
      svn checkout http://dev.thep.lu.se/svndigest/svn/tags/A.B svndigest-A.B
      
      svn switch http://dev.thep.lu.se/svndigest/svn/tags/A.B
      
    3. In section svndigest stable update link to [milestone:"svndigest A.B.1" A.B.1] and modify the svn commands to
      svn checkout http://dev.thep.lu.se/svndigest/svn/branches/A.B-stable svndigest-A.B
      
      svn switch http://dev.thep.lu.se/svndigest/svn/branches/A.B-stable
      
    4. In section svndigest devel update link to [milestone:"svndigest A.B+1" A.B+1].

    5. On WikiStart update links `[source:branches/A.B-stable/doc/readme.txt Manual], NEWS, [source:branches/A.B-stable/README README]`, and also make sure that list of features is up to date.

  11. Update the version list in Trac using the trac-admin tool. Remember to set the date

  12. Close the milestone associated with the release and replace head with appropriate revision. Add a new milestone as needed (with log link).

  13. Merge the release into the trunk. To avoid confusion and minimize the risk of loosing fixes, this step is only performed by the Merge Master.

    1. Go to a pristine trunk WC.
      cd /path/to/svndigest-trunk
      svn update
      svn diff
      
    2. Merge changes into trunk WC.
      svn merge ^/branches/A.B-stable
      
    3. Resolve all conflicts. Run tests and perform all other appropriate tests to make sure that the merge does not create havoc. Typically changes in m4/version.m4 are problematic so check this file extra carefully.

    4. Commit changes to the trunk branch.
      svn commit -m "Merged release A.B to the trunk."
      
  14. Prepare the minor branch for the first patch release

    1. Update version number in version.m4. Locate and change the below line
      m4_define([PATCH_VERSION], [1])
      m4_define([SVNDIGEST_DEV_BUILD], [true])
      
    2. Add an entry in NEWS
      version A.B.1 (released NOT YET)
      
      The date is set when version A.B.1 is released.

    3. Commit changes to the repository, svn ci -m "Bumping version"

Patch release procedure

This section describes what to do when publishing a patch release A.B.C.

  1. Make sure that all commits are performed into to the branch, such as bumping version number(s) (version.m4), acknowledge contributions (THANKS), update file NEWS.

    1. Update version number in m4/version.m4. Locate and change the below line
      m4_define([SVNDIGEST_DEV_BUILD], [false])
      
    2. Update THANKS.

    3. Set the date for the new release in NEWS
      version A.B.C (released 27 June 2007)
      
      Make sure that the items in NEWS cover all important bug fixes of the release.

  2. Commit changes to the repository, svn ci -m "Preparing release A.B.C"

  3. Update copyright statements with commands

    make check && ./bin/svncopyright -v
    
    Examine the updates and commit changes with `svn ci -m "updating copyright statements"`.

  4. Issue svn update to make entire wc to be in revision HEAD. Needless to say, make sure that the program is in a state to be released; make sure that all the tests pass, test the distribution package, and perform all other release tests you think is appropriate:

    Run
    make
    make release
    
    Fix potential problems

  5. Check that you are synchronized with repository
    svn status -qu
    
    and then create a tag
    svn copy ^/branches/A.B-stable ^/tags/A.B.C -m "tagging version A.B.C"
    
  6. Upload svndigest-A.B.C.tar.gz and md5 file to sourceforge using scp like
    scp svndigest-A.B.C.tar.gz svndigest-A.B.C.tar.gz.MD5 USER,svndigest@frs.sourceforge.net:/home/frs/project/s/sv/svndigest/.
    
  7. Update SubversionCheckout and WikiStart

    1. Update the section Latest stable release to reflect the new version, that is

      • Change the version number

      • Update the package link to the new version

      • Update link to NEWS file to source:tags/A.B.C/NEWS

    2. In section svndigest latest release update link to [source:tags/A.B.C/NEWS NEWS] and modify the svn commands to
      svn checkout http://dev.thep.lu.se/svndigest/svn/tags/A.B.C svndigest-A.B.C
      
      svn switch http://dev.thep.lu.se/svndigest/svn/tags/A.B.C
      
    3. In section svndigest stable update link to [milestone:"svndigest A.B.[C+1]" A.B.[C+1]].

    4. On WikiStart update reference to explicit latest version number, and links [source:tags/A.B.C/NEWS NEWS].

  8. Close the milestone associated with the release and replace head with appropriate revision in log link. Add a new milestone as needed (with a log link).
  9. Update the version list in Trac using the trac-admin tool. Remember to set the date

  10. Merge the patch release into the trunk. To avoid confusion and minimize the risk of loosing fixes, this step is only performed by the Merge Master.

    1. go to a pristine trunk WC
      cd /path/to/svndigest-trunk
      svn update
      svn diff
      
    2. Merge changes into trunk. In this example the diffence between a minor release tag and the first patch release tag is merged into the trunk WC
      svn merge ^/branches/A.B-stable
      
    3. Resolve all conflicts. Run tests and perform all other appropriate tests to make sure that the merge does not create havoc. Note, changes in version.m4 should typically not be merged into trunk.

    4. Commit changes to the trunk branch.
      svn commit -m "Merged patch release A.B.1 to the trunk. Delta A.B.1 - A.B"
      
  11. Prepare the minor branch for the next patch release

    1. Update version number in m4/version.m4. Locate and change the below line
      m4_define([PATCH_VERSION], [C+1])
      m4_define([SVNDIGEST_DEV_BUILD], [true])
      
    2. Add an entry in NEWS
      version A.B.[C+1] (released DATE)
      
      The date is set when version A.B.[C+1] is released.

    3. Commit changes to the repository, svn ci -m "Changes for future release A.B.[C+1]"