Release guidelines

From MCRL2

General guidelines

• An mCRL2 toolset release takes place every 6 months.
• The precise next release date is determined well in advance by the mCRL2 developers.
• During a period of 15 days prior to the release date, only bug-fixing changes to the development source tree are allowed. Feature additions or large, structural changes are not allowed. Also, every bug fix should be checked by at least one person other than its author, prior to its submission into the source tree.
• The version number of a release consists of the month (full name) and year of the release date. For example: "January 2008".
• The release itself consists of at least (but not limited to) one binary Windows package and one source code package. These are made available for download on the mCRL2 website.

Detailed release procedure

• build, test the source distribution
  • build from the root of the repository

     packaging/generate_source_distribution.sh trunk .

• • build and test (statically linked)

     ./configure --prefix=/tmp/mcrl2
     ./build/bin/bjam link=static ./status -l300 --preserve-test-targets
     ./build/bin/bjam --install link=static

• • build and test (dynamically linked)

     ./configure --prefix=/tmp/mcrl2
     ./build/bin/bjam link=shared ./status -l300 --preserve-test-targets
     ./build/bin/bjam --install link=static

• build, test, and upload the windows binary distribution

    ./build/bin/bjam link=shared ./status -l300 --preserve-test-targets
    ./build/bin/bjam --prefix=c:/mcrl2 --install link=shared

• • add README, CHANGES, COPYING and LICENSE_1_0.txt to the installation directory
  • create self-extracting zip-file of the installation directory
  • upload to mcrl2@www.win.tue.nl/www/dowload/release/

• Create a tag in subversion repository:

svn copy https://svn.win.tue.nl/repos/MCRL2/trunk \
         https://svn.win.tue.nl/repos/MCRL2/tags/release-2008-07

• Update OS X bundle version tags in meta information. The following command can be used to automate this task.

    sed -i 's/July 2008 (development)/July 2008 (release)/' $(find -iname '*.plist')

• Update toolset version tag.
  • edit version_tag and copyright period in libraries/utilities/include/mcrl2/utilities/command_line_interface.h
• Generate source distribution and upload:

 svn checkout https://svn.win.tue.nl/repos/MCRL2/tags/release-2009-01
 svn checkout https://svn.win.tue.nl/repos/MCRL2/packaging
 sh packaging/generate_source_distribution.sh tags/release-2009-01 .
 scp mcrl2-svn5546-src.tar.bz2 mcrl2@www.win.tue.nl:www/download/release/mcrl2-200901-src.tar.bz2

• Set new development tags in trunk:

 sed -i 's/July 2008 (release)/January 2009 (development)/' $(find -iname '*.plist')