Home

Welcome to the BLM-py wiki!

This wiki details how to create a new release for developers of the BLM-py toolbox.

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

3. Create a pull request from the new_release_{{Version number}} branch and document all the changes as an itemized list in the top comment. Note: the list of commits between the new_release_{{Version number}} branch and a given tag can be obtained with git log --pretty=oneline new_release_{{Version number}}...vx.x.x where vx.x.x must be replaced by the actual tag name. Please make reference to all issues addressed and 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).

4. Run the tests described in readme.md and copy the output of the verification scripts into the comments on the pull request.

5. If any test fails, update the code and iterate 3-4 until all tests pass.

6. Change the title of the pull request into Release BLM-py Version 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/TomMaullin/BLM-py/releases

9. Click Draft a new release and fill in: - Tag version: vX.X.X (where X.X.X is the actual version) - Target: master (keep default value) - Release title: Version X.X.X (where X.X.X is the actual version) - Describe this release: copy/paste the itemized list from the corresponding merged PR.

10. Click on Publish release.