Home

Welcome to the SnPM-devel wiki!

How to create a new release

1. Create a new branch called new_release out of master
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.