Release Candidate 3.2.1
Release Checklist
Assuming that current release number is of the form 3.N.n
-
Create an issue for the release, with description "Release Candidate 3.N.n", including this release checklist in the description. Update the issue by checking the boxes of each task as it is completed. -
Resolve as many merge requests and issues as feasible -
Compare changes in dev
to the prior release; using "Compare" under "Repository", compare Source:dev
to Target:master
-
Update the root README.md in the dev
branch with release notes associated with the differences betweendev
andmaster
, if they haven't already been added
-
-
Update all version numbers and release dates in the dev
branch files (see checklist below) -
Create a new branch from the dev
branch calledrelease-candidate-3.N.n
-
Create a merge request from the release-candidate-3.N.n
branch to themaster
branch- Check the box for "Delete source branch when merge request is accepted."
-
Merge the release-candidate-3.N.n
branch into themaster
branch -
Create a tag and release: Repository
->Tags
->New tag
-
Tag: v3.N.n -
Create from: master
-
Message: Version 3.N.n, Release YYYYa -
Release notes: include the release updates from README.md
-
-
In the dev
branch, change release number to3.N.n-dev
in all the places listed below and remove dates -
Close the issue associated with this release (check this box just before closing the issue)
Files that need to be updated with the version and/or release date (commit all changes after completing the checklist)
-
doc/html/index.html
-
First H1 header -
Downloading development version -
Under "How to Cite" (includes exact release date)
-
-
README.md
- First two lines (includes exact release date)
-
doc/html/helptoc.xml
- Change toc version
-
maintenance/create_topcontents.m
-
Contents.m
- autogenerated bymaintenance/create_topcontents.m
-
Verify that 'ver' reports the update version and Release, which should be formmated as RYYYYz where YYYY is the year and z is the release letter, starting with 'a'
-
-
Rebuild help index: - Remove current index directory:
doc/html/helpsearch-v3
cd doc/html; builddocsearchdb(pwd)
- Remove current index directory: