Skip to content

Release procedure

Mike Hucka edited this page Nov 27, 2017 · 11 revisions

The following is the process followed for doing a new release of the SBML Test Runner:

  1. Update the version number in VERSION.txt at the top level of the repo

  2. Update NEWS.md at the top level of the repo

  3. 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
  4. Update AUTHORS.md, if appropriate, at the top level of the repo

  5. Update cases/README.md, cases/semantic/README.md, cases/stochastic/README.md, and cases/syntactic/README.md, as appropriate

  6. Update src/test-runner/README.md, as appropriate

  7. 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.

  8. Update src/front-ends/standalone/testsuite-ui/README.md

  9. 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 named sbml-semantic-cases-dist-NNNN-NN-NN.zip at the top level of the repo. Leave it there for the remaining steps.

  10. 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.

Clone this wiki locally