Skip to content

Release Checklist

Jump to bottom Edit New page
Abhiram edited this page May 13, 2022 · 9 revisions

Things to do before releasing a new version of OWA SWMM

  1. Create a draft release branch

Please create a new branch from the branch we want to merge into master as a new release. For example, say we want to merge develop into master, you can use the following command to create draft_release from develop.

git checkout -b draft_release develop
  1. Create a Pull Request from the draft release branch to master

Please ensure that at least one of the maintainers is tagged as a reviewer on this PR.

  1. Ensure that unit tests in Github Actions are running on all operating systems and passing

Refer to the Github Actions and check on the status of the tests. Screen Shot 2022-04-20 at 11 29 21 PM

  1. Check that the build logs are clean Confirm the build logs in Github Actions don't have errors and they are all working as intended

  2. Confirm that the CONTRIBUTORS file is updated with names, roles, and contributions The contributors list is in https://github.com/OpenWaterAnalytics/Stormwater-Management-Model/blob/develop/CONTRIBUTORS

  3. Confirm version number CMake handles the version number. It is in https://github.com/OpenWaterAnalytics/Stormwater-Management-Model/blob/develop/CMakeLists.txt.

  4. Confirm documentation build

  5. Make sure the downstream dependencies, swmm-python, and pyswmm, are working with the draft release branch.

Add a custom footer
Add a custom sidebar
Clone this wiki locally