Home

Welcome to the SwE wiki!

This wiki details how to create a new release for developers of the SwE toolbox. For a full users guide to the SwE toolbox, please see the NISOx website!

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 SwE you intend on making a release for. The version number increase should follow the versioning system described in https://en.m.wikipedia.org/wiki/Software_versioning. Roughly speaking, the version number should go up by 0.0.1 for fixed bugs & developer fixes and by 0.1.0 when new features are added to the toolbox.

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. Wait for the Travis testing suite to run.

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

6. Increment SwE version number in line 10 of swe.m and add/commit/push this update.

7. Change the title of the pull request into Release SwE Version X.X.X where X.X.X if the number of the version to be released.

8. Merge the pull request into master.

9. Go to https://github.com/NISOx-BDI/SwE-toolbox/releases

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

11. Click on Publish release.