Skip to content

Latest commit

 

History

History
28 lines (24 loc) · 1.32 KB

RELEASE.md

File metadata and controls

28 lines (24 loc) · 1.32 KB
Raw

Releasing stapi-fastapi

Publishing a stapi-fastapi package build to PyPI is triggered by publishing a GitHub release. Tags are the semantic version number proceeded by a v, such as v0.0.1.

Release notes for the changes for each release should be tracked in CHANGELOG.md. The notes for each release in GitHub should generally match those in the CHANGELOG.

Release process

  1. Prepare the release.
    1. Figure out the next release version (following semantic versioning conventions).
    2. Ensure CHANGELOG.md has all necessary changes and release notes under this next release version. Typically this step is simply a matter of adding the header for the next version below Unreleased then reviewing the list of changes therein.
    3. Ensure links are tracked as best as possible to relevant commits and/or PRs.
  2. Make a PR with the release prep changes, get it reviewed, and merge.
  3. Draft a new GitHub release.
    1. Create a new tag with the release version prefixed with the character v.
    2. Title the release the same name as the tag.
    3. Copy the release notes from CHANGELOG.md for this release version into the release description.
  4. Publish the release and ensure it builds and pushes to PyPI successfully.