-
Notifications
You must be signed in to change notification settings - Fork 12
Release procedure
The following is the process followed for doing a new release of the SBML Test Runner:
-
Update the version number in
VERSION.txt
at the top level of the repo -
Update
NEWS.md
at the top level of the repo -
Update
README.md
at the top level of the repo- Update the version number embedded in the shields.io link near the top
- Update the text of the file as necessary
-
Update
AUTHORS.md
, if appropriate, at the top level of the repo -
Update
cases/README.md
,cases/semantic/README.md
,cases/stochastic/README.md
, andcases/syntactic/README.md
, as appropriate -
Update
src/test-runner/README.md
, as appropriate -
Update src/front-ends/standalone/testsuite-ui/CHANGES.md. This summary of changes is used in the binary installer, and is displayed in the read me/release notes part of the installer. This has to be edited manually and kept relatively short because of the small window in which the text is displayed in the installer.
-
Run
make cases-dist
from the top level of the repository. If you have not done this recently, this step may take a very long time as it rebuilds images and HTML files for the thousands of test cases. (You may find the-j
option helpful; e.g., if you have a quad-core machine,make -j 4 cases-dist
.) After this, you should end up with a file namedsbml-semantic-cases-dist-NNNN-NN-NN.zip
at the top level of the repo. Leave it there for the remaining steps. -
Commit all changes to branch
master
. Remember to reference GitHub issues if they are fixed, and use the special keywords understood by GitHub to help close issues if appropriate.