Release checklist » History » Version 11

Version 10 (Mark Abraham, 06/14/2018 09:17 AM) → Version 11/21 (Mark Abraham, 06/14/2018 11:51 AM)

h1. Release checklist

* add new redmine version targets
* bump bugs that won't get fixed in time to next version (or untag a version number)
* check the post-submit and nightly Jenkins matrices are building suitably well
merge in appropriate branches from earlier releases
* if regressiontests changes with matching source changes are needed, do the cross-verify checks to see that things are working, and plan to submit the patches either early or the very last thing, to minimize mysterious Jenkins failures because an outdated parent is in use
* announce release schedule - give devs a week or two to fix things they intended to fix, provide links to gerrit and redmine pages for that branch/version
* bump shared object minor version for point releases
* consider bumping shared object major version for point releases - see cmake/gmxVersionInfo.cmake for policy
* check for new GROMACS papers that should be mentioned in source and manual

* run release workflow a few days in advance to check things work
- this also builds the tarball correctly, when the RELEASE checkbox is ticked, which we need for updating the REGRESSIONTEST_MD5SUM in cmake/gmxVersionInfo.cmake
- TODO automate this along the lines of the regressiontests auto-builder

* upload source tarball to FTP site, give correct permissions, check link works - TODO automate the stuff below into a Jenkins job that we trigger manually after the release workflow is satisfactory

Here's a script to help automate that on Jenkins
#!/bin/bash download="wget -N"

# Jenkins is able to work out what Get the version is for the various tarballs
# Release_workflow_master, so we can put that to use for the publish $download "*zip*/"
# workflow, too.

cp ${website_tarball}
patch=2 $download$regressiontests_tarball

#suffix= <pre>
#suffix=-rc1 upload="rsync -avP --chmod=u+rw,g+rw,o+r"
version=$major$suffix $upload $source_tarball $destination/gromacs/
$upload manual-${version}.pdf $destination/manual/
$upload $regressiontests_tarball $destination/regressiontests/

website_tarball="Website-${version}.zip" md5sum $source_tarball
regressiontests_tarball="regressiontests-${version}.tar.gz" md5sum $regressiontests_tarball
source_tarball="gromacs-${version}.tar.gz" </pre>


download="wget -N"

upload="rsync -avP --chmod=u+rwX,g+rwX,o+rX"

$download "*zip*/"
cp ${website_tarball}
# Unpack the website tarball
cd /tmp
unzip -o -u $originalpwd/${website_tarball} #>& >& /dev/null
echo "done unzip"
ls Website/*
$upload Website/* Website/.[a-z]* $deploymentlocation/${version}/
echo "done upload"
cp Website/manual*pdf $originalpwd
#rm -rf Website

# Get the various tarballs and manual to the ftp server. Note that the
# GROMACS source repo has in the URL for the
# regressiontest tarball download, but actually the requests are
# redirected to server.
upload="rsync -avP --chmod=u+rw,g+rw,o+r"
$upload $source_tarball $destination/gromacs/
$upload manual-${version}.pdf $destination/manual/
$upload $regressiontests_tarball $destination/regressiontests/

# Echo these to the terminal for convenient double checking
md5sum $source_tarball
md5sum $regressiontests_tarball

* update News on front of GROMACS web page -
* TODO make notes of what goes into the commit for the new version and the one that follows the tagged commit
- check the contents of the release notes, particuarly for commits since the last release that have no
release notes yet, e.g. with @git log --oneline@ vs @git log --oneline -- docs/release-notes@
- tag the commit from which the tarball was made, and do explicit upload to repo
- update REGRESSIONTEST_BRANCH if needed (major release)
- sometimes bump GMX_VERSION_* variables
- bumps to release notes index.rst and directory structure

* once the gerrit change is submitted and the release email sent, make tag of the correct form in local repo
* bump version in cmake/gmxVersionInfo.cmake in the commit following the tag.
* add new stub file for release notes for next version, and entry in index.rst
* git push --tags to gerrit repo
* later, check tags propagate to gromacs and github
* post on gmx-users and gmx-announce.
* post on Google+ and Facebook pages
* thank gmx-developers
* bump/close/update open redmine issues
* close completed redmine versions
* beer

TODO some recent examples of post-release emails