forked from USEPA/Stormwater-Management-Model
-
Notifications
You must be signed in to change notification settings - Fork 77
Release Checklist
Abhiram edited this page Apr 21, 2022
·
9 revisions
Things to do before releasing a new version of OWA SWMM
- 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
- 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.
- 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.
NOTE: Maybe this is redundant?
- Check that build logs are clean (no warning or errors)
- Update and pin down dependencies (TODO: add specifics)
- Update the
CONTRIBUTORS
file with names, roles, and contributions - Double check version numbering
- Update documentation and check build documentation
- Double check compiler warnings and errors
- Make sure the downstream dependencies, swmm-python, and pyswmm, are working with the draft release branch.