Skip to content

RELEASING.md

Latest commit

 

History

History
18 lines (16 loc) · 1.07 KB

RELEASING.md

File metadata and controls

18 lines (16 loc) · 1.07 KB

Releasing

  1. Determine which package you're releasing
  2. Determine the next version, following semantic versioning
  3. Create a release branch: git checkout -b release/{package}-v{version}
  4. Update that package's pyproject.toml with the new version
  5. Update that package's CHANGELOG with:
    • A new header with the new version
    • A new link at the bottom of the CHANGELOG for that header
  6. git push -u origin
  7. Once approved, merge the PR
  8. git checkout main && git pull && scripts/release {package}
  9. Go to the draft release href provided by the script, update that Github release with information from the CHANGELOG, and publish it
  10. Github actions will automatically publish a new PyPI release

Important

You'll need to set up .netrc authentication to use scripts/release. The tag format created by the script ({package}/v{version}) is very important, because that's how we discover which package to build and publish in Github Actions.