Skip to content

release_steps.md

Latest commit

 

History

History
51 lines (35 loc) · 1.04 KB

release_steps.md

File metadata and controls

51 lines (35 loc) · 1.04 KB

Release Steps

Quick Release

  1. Update release notes (RELEASE_NOTES.md)
  2. Bump version (bumpversion [patch|minor|major])
  3. Push new tag (git push origin main --tags)

Bump version (updates files + creates tag)

To not create a tag, use --no-tag.

bumpversion [patch|minor|major]

Create and push tag (triggers automated PyPI deployment)

git push origin main --tags

Monitor: https://github.com/terminusdb/terminusdb-client-python/actions

Details

What bumpversion updates

  • terminusdb_client/__version__.py
  • pyproject.toml
  • .bumpversion.cfg

Automated deployment

Pushing a tag triggers GitHub Actions to:

  • Run tests (Python 3.8-3.12)
  • Build with Poetry
  • Publish to PyPI

Manual deployment (if needed)

poetry build
poetry publish

Troubleshooting

Version conflicts: Never delete published PyPI versions. Create a new patch release instead.

Prerequisites

  • Install: pip install bumpversion
  • PyPI publishing handled via PYPI_API_TOKEN secret in GitHub Actions