Skip to content

Latest commit

 

History

History
23 lines (12 loc) · 1.28 KB

RELEASE_CHECKLIST.md

File metadata and controls

23 lines (12 loc) · 1.28 KB

Release Checklist

For the sake of consistency, this is how a release of scripture_phaser should be done.

  1. Increment the VERSION and RELEASE DATE in variables in src/enums.py.

  2. Update the version in pyproject.toml

  3. Update the documentation in README.md if necessary.

  4. Successfully merge your PR from your feature branch into master.

  5. If the release constitutes a patch release, merge master into the existing MAJOR.MINOR.x branch. Otherwise, branch off of master into a new branch with the name MAJOR.MINOR.x.

  6. Make sure that you don't have a preexisting dist folder in the root of the scripture_phaser repository. On the MAJOR.MINOR.x branch, run: python -m build.

  7. From the root of the scripture_phaser repository, run: python -m twine upload --repository pypi dist/*.

  8. Tag the commit on the MAJOR.MINOR.x branch with the MAJOR.MINOR.PATCH version number. git tag MAJOR.MINOR.PATCH COMMIT

  9. Push the tag to GitHub. git push origin MAJOR.MINOR.PATCH.

  10. Create a release on GitHub by clicking the tags button to the right of the branch selection dropdown. Provide a detailed description of the release and select the tag that was just pushed to mark the release. Upload the contents of the dist folder in the scripture_phaser directory to the release.