Home

Welcome to the SnPM-devel wiki!

How to create a new release

1. Create a new branch called new_release_{{Version number}} out of master, where {{Version number}} is replaced with the version number of SnPM you intend on making a release for.
2. Merge in all the unmerged updates that will be part of the release using git merge BRANCH_NAME where BRANCH_NAME is replaced by the name of the branch to be added to that release.

• Create a pull request from the new_release branch and document all the changes as an itemized list in the top comment. Note: the list of commits between the new_release branch and a given tag can be obtained with git log --pretty=oneline new_release...SnPMxx.x.x where SnPMxx.x.x must be replaced by the actual tag name. Please use one of the following prefixes for each item:
  • fix: for updates that fix an error and
  • enh: for other enhancements,
  • dev: for fixes that only impact the GitHub repository and the development process (e.g. pull request templates).

3. Run the tests as specified in doc: Non-regression testing and copy the test report in a comment in the pull request.
4. If any test fails, update the code and iterate 3-4 until all tests pass.
5. Increment SnPM version number in line 52 of snpm.m, as well as on lines 1, 22 and 23 of CITATION.CFF, and add/commit/push this update.
6. Change the title of the pull request into Release SnPM X.X.X where X.X.X if the number of the version to be released.
7. Merge the pull request into master.
8. Go to https://github.com/SnPM-toolbox/SnPM-devel/releases
9. Click Draft a new release and fill in:

• Tag version: SnPMX.X.X (where `X.X.X is the actual version)
• Target: master (keep default value)
• Release title: SnPM X.X.X (where `X.X.X is the actual version)
• Describe this release: copy/paste the itemized list from the corresponding merged PR.

9. Click on Publish release
10. Modify link to the zip on SnPM website.