Skip to content

RELEASE.md

Latest commit

 

History

History
33 lines (27 loc) · 1.35 KB

RELEASE.md

File metadata and controls

33 lines (27 loc) · 1.35 KB

Releasing to PyPI

  1. Ensure main is ready to release.
  2. Make sure CHANGELOG.md is up to date (review commit history to verify, open a Release PR if changes are needed).
  3. Verify the version in CHANGELOG.md matches the version you're about to tag.
  4. If a new brainset pipeline has been added, verify that it is mentioned in the project README.
  5. Create and push the release tag (see here for version syntax).
$ git checkout main
$ git pull origin main
$ git tag vX.Y.Z
$ git push origin vX.Y.Z
  1. Monitor the GitHub Actions workflow to ensure the build and publish succeed.
  2. Add a GitHub Release with a small description of changes from the last release.

Note: Tags must start with "v" for the publishing GitHub Action to begin.

Valid version numbers and their meaning

  • For version number, we follow SemVer (major.minor.patch).
  • For pre-release tags, we follow the PEP440 syntax:
vX.Y.ZaN   # Alpha release
vX.Y.ZbN   # Beta release
vX.Y.ZrcN  # Release candidate
vX.Y.Z     # Final release
  • For post-release tags, we also follow the PEP440 syntax:
    • vY.Y.Z.postN, vX.Y.Z.aN.postM, ...
    • Post releases are only meant for metadata/distribution related corrections, and not code edits