Skip to content

RELEASE.md

Latest commit

 

History

History
44 lines (33 loc) · 898 Bytes

RELEASE.md

File metadata and controls

44 lines (33 loc) · 898 Bytes

Release Workflow

Quick Start

Daily Development

Use conventional commits:

git commit -m "feat: add new feature"    # New feature
git commit -m "fix: resolve bug"         # Bug fix
git commit -m "docs: update readme"      # Documentation

Making a Release

# 1. Update version (from main branch)
cz bump

# 2. Push to GitHub
git push && git push --tags

# 3. Done! GitHub Actions handles the rest

The automation will:

  • Update version in code
  • Generate CHANGELOG
  • Create GitHub Release
  • Publish to PyPI (after approval)

Test Release (Optional)

Test on TestPyPI first:

  1. Go to GitHub Actions → "Release" workflow
  2. Click "Run workflow" → Enter version
  3. Install: pip install -i https://test.pypi.org/simple/ athm==VERSION

If Something Goes Wrong

# Delete tag and try again
git tag -d vX.Y.Z
git push origin :refs/tags/vX.Y.Z