Skip to content
Abhiram edited this page Apr 21, 2022 · 9 revisions

Things to do before releasing a new version of OWA SWMM

  1. Create a draft release branch

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

NOTE: Maybe this is redundant?

  1. Check that build logs are clean (no warning or errors)
  2. Update and pin down dependencies (TODO: add specifics)
  3. Update the CONTRIBUTORS file with names, roles, and contributions
  4. Double check version numbering
  5. Update documentation and check build documentation
  6. Double check compiler warnings and errors
  7. Make sure the downstream dependencies, swmm-python, and pyswmm, are working with the draft release branch.
Clone this wiki locally