Project

General

Profile

Release checklist » History » Version 17

Paul Bauer, 11/29/2018 12:12 PM
Updated location for documentation upload

1 1 Mark Abraham
h1. Release checklist
2 1 Mark Abraham
3 2 Mark Abraham
* add new redmine version targets
4 2 Mark Abraham
* bump bugs that won't get fixed in time to next version (or untag a version number)
5 11 Mark Abraham
* check the post-submit and nightly Jenkins matrices are building suitably well
6 2 Mark Abraham
* merge in appropriate branches from earlier releases
7 6 Mark Abraham
* 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
8 2 Mark Abraham
* 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
9 3 Mark Abraham
* bump shared object minor version for point releases
10 3 Mark Abraham
* consider bumping shared object major version for point releases - see cmake/gmxVersionInfo.cmake for policy
11 2 Mark Abraham
* check for new GROMACS papers that should be mentioned in source and manual
12 5 Mark Abraham
13 5 Mark Abraham
* run release workflow a few days in advance to check things work
14 5 Mark Abraham
  - this also builds the tarball correctly, when the RELEASE checkbox is ticked, which we need for updating the REGRESSIONTEST_MD5SUM in cmake/gmxVersionInfo.cmake
15 5 Mark Abraham
  - TODO automate this along the lines of the regressiontests auto-builder
16 5 Mark Abraham
17 13 Mark Abraham
* put stuff on the FTP site only when ready to make the release announcement, as some distros automatically scan URLs for tarballs
18 7 Mark Abraham
* 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
19 4 Mark Abraham
20 11 Mark Abraham
Here's a script to help automate that on Jenkins
21 1 Mark Abraham
<pre>
22 11 Mark Abraham
#!/bin/bash
23 1 Mark Abraham
24 11 Mark Abraham
# Jenkins is able to work out what the version is for the
25 11 Mark Abraham
# Release_workflow_master, so we can put that to use for the publish
26 11 Mark Abraham
# workflow, too.
27 1 Mark Abraham
28 11 Mark Abraham
major=2018
29 11 Mark Abraham
patch=2
30 4 Mark Abraham
31 11 Mark Abraham
#suffix=
32 11 Mark Abraham
#suffix=-rc1
33 11 Mark Abraham
suffix=.$patch
34 11 Mark Abraham
version=$major$suffix
35 4 Mark Abraham
36 11 Mark Abraham
website_tarball="Website-${version}.zip"
37 11 Mark Abraham
regressiontests_tarball="regressiontests-${version}.tar.gz"
38 11 Mark Abraham
source_tarball="gromacs-${version}.tar.gz"
39 11 Mark Abraham
download="wget -N" 
40 11 Mark Abraham
41 1 Mark Abraham
upload="rsync -avP --chmod=u+rwX,g+rwX,o+rX"
42 17 Paul Bauer
deploymentlocation=mark@www.gromacs.org:/var/www/manual
43 11 Mark Abraham
$download "http://jenkins.gromacs.org/job/Release_workflow_master/Website/*zip*/Website.zip"
44 11 Mark Abraham
originalpwd=$PWD
45 11 Mark Abraham
cp Website.zip ${website_tarball}
46 1 Mark Abraham
# Unpack the website tarball
47 1 Mark Abraham
(
48 1 Mark Abraham
    cd /tmp
49 11 Mark Abraham
    unzip -o -u $originalpwd/${website_tarball} #>& /dev/null
50 11 Mark Abraham
    echo "done unzip"
51 11 Mark Abraham
    ls Website/*
52 1 Mark Abraham
    $upload Website/* Website/.[a-z]* $deploymentlocation/${version}/
53 11 Mark Abraham
    echo "done upload"
54 1 Mark Abraham
    cp Website/manual*pdf $originalpwd
55 4 Mark Abraham
    #rm -rf Website
56 4 Mark Abraham
)
57 4 Mark Abraham
58 11 Mark Abraham
# Get the various tarballs and manual to the ftp server. Note that the
59 11 Mark Abraham
# GROMACS source repo has gerrit.gromacs.org in the URL for the
60 11 Mark Abraham
# regressiontest tarball download, but actually the requests are
61 11 Mark Abraham
# redirected to ftp.gromacs.org server.
62 11 Mark Abraham
$download http://jenkins.gromacs.org/job/Regressiontests_package_master/lastSuccessfulBuild/artifact/regressiontests/$regressiontests_tarball
63 11 Mark Abraham
$download http://jenkins.gromacs.org/job/Source_package_master/lastSuccessfulBuild/artifact/build/$source_tarball
64 11 Mark Abraham
upload="rsync -avP --chmod=u+rw,g+rw,o+r" 
65 11 Mark Abraham
destination=mark@ftp.gromacs.org:/srv/ftp
66 11 Mark Abraham
$upload $source_tarball $destination/gromacs/
67 11 Mark Abraham
$upload manual-${version}.pdf $destination/manual/
68 11 Mark Abraham
$upload $regressiontests_tarball $destination/regressiontests/
69 11 Mark Abraham
70 11 Mark Abraham
# Echo these to the terminal for convenient double checking
71 11 Mark Abraham
md5sum $source_tarball
72 11 Mark Abraham
md5sum $regressiontests_tarball
73 1 Mark Abraham
</pre>
74 1 Mark Abraham
75 12 Mark Abraham
* update symlinks for current version in www at /var/www/documentation
76 10 Mark Abraham
* update News on front of GROMACS web page - http://www.gromacs.org/
77 10 Mark Abraham
* TODO make notes of what goes into the commit for the new version and the one that follows the tagged commit
78 10 Mark Abraham
    - check the contents of the release notes, particuarly for commits since the last release that have no
79 5 Mark Abraham
      release notes yet, e.g. with @git log --oneline@ vs @git log --oneline -- docs/release-notes@
80 5 Mark Abraham
    - tag the commit from which the tarball was made, and do explicit upload to gerrit.gromacs.org repo
81 5 Mark Abraham
    - update REGRESSIONTEST_BRANCH if needed (major release)
82 5 Mark Abraham
    - sometimes bump GMX_VERSION_* variables
83 5 Mark Abraham
    - bumps to release notes index.rst and directory structure
84 3 Mark Abraham
85 3 Mark Abraham
* once the gerrit change is submitted and the release email sent, make tag of the correct form in local repo
86 14 Mark Abraham
* bump version in cmake/gmxVersionInfo.cmake in the commit following the tag (look at previous release commits) - prepare this commit in advance, finalize any TODO on the day
87 14 Mark Abraham
* add new stub file for release notes for next version, and entry in index.rst in commit to follow teh release commit
88 3 Mark Abraham
* git push --tags to gerrit repo
89 2 Mark Abraham
* later, check tags propagate to gromacs and github
90 16 Paul Bauer
91 16 Paul Bauer
* get main manual.gromacs.org website documentation from bitbucket repository: https://bitbucket.org/tcblab/gromacs-deployment/src/master/
92 16 Paul Bauer
* edit index.rst to include new version/updated point release
93 16 Paul Bauer
* check that top-level-make-and-deploy.sh script does what it should do and if necessary update the script (example below)
94 16 Paul Bauer
<pre>
95 16 Paul Bauer
#!/bin/bash
96 16 Paul Bauer
set -x
97 16 Paul Bauer
user=pbauer
98 16 Paul Bauer
99 16 Paul Bauer
deploymentlocation=${user}@www:/var/www/documentation
100 16 Paul Bauer
101 16 Paul Bauer
# Re-make the top-level documentation for all versions
102 16 Paul Bauer
make html
103 16 Paul Bauer
104 16 Paul Bauer
# Ensure useful read permissions when placing on a server
105 16 Paul Bauer
upload="rsync -avP --chmod=u+rwX,g+rwX,o+rX"
106 16 Paul Bauer
$upload -av _build/html/ $deploymentlocation/ --exclude _sources --exclude .buildinfo --exclude objects.inv
107 16 Paul Bauer
</pre>
108 16 Paul Bauer
* run script in top level of butbucket repository
109 16 Paul Bauer
* check that website has been updated correctly
110 16 Paul Bauer
111 2 Mark Abraham
* post on gmx-users and gmx-announce.
112 3 Mark Abraham
* post on Google+ and Facebook pages
113 2 Mark Abraham
* thank gmx-developers
114 2 Mark Abraham
* bump/close/update open redmine issues
115 2 Mark Abraham
* close completed redmine versions
116 2 Mark Abraham
* beer
117 2 Mark Abraham
118 2 Mark Abraham
119 1 Mark Abraham
TODO some recent examples of post-release emails
120 15 Mark Abraham
121 15 Mark Abraham
122 15 Mark Abraham
To make this work, mark and pbauer are members of www group on www.gromacs.org (which is still running some old OS that can support the old WWW server software), and ftpadmins on ftp.gromacs.org, and the respective directories have write permissions for that group. TODO update the above logic to make sure that rsync sets the group attributes to those groups.