Skip to content

RELEASING.md

Latest commit

 

History

History
142 lines (97 loc) · 3.31 KB

RELEASING.md

File metadata and controls

142 lines (97 loc) · 3.31 KB

Releasing BinPackage to PyPI

This guide explains how to release a new version of BinPackage to PyPI.

Prerequisites

  • Write access to the GitHub repository
  • PyPI account with maintainer access to islenska package
  • gh CLI tool installed and authenticated
  • Python 3.9+ with build and twine packages

Release Process

1. Update Version Number

Edit pyproject.toml and update the version:

version = "1.1.0"  # Update this

2. Commit and Tag

git add pyproject.toml
git commit -m "Bump version to 1.1.0 for release"
git tag -a 1.1.0 -m "Release version 1.1.0

[Brief description of changes]
"
git push origin main
git push origin 1.1.0

Pushing the tag triggers the wheel building workflow on GitHub Actions.

3. Wait for Wheel Builds

Monitor the build progress:

gh run list --workflow=wheels.yml --limit 3

Or visit: https://github.com/mideind/BinPackage/actions/workflows/wheels.yml

Builds typically take 10-15 minutes.

4. Download and Prepare Release

Once the build completes successfully, use the automated release script:

# Get the run ID from step 3
RUN_ID=18731185158  # Example - use actual ID

# Run the release script
./release-to-pypi.sh $RUN_ID

The script will:

  • Download wheel artifacts from all platforms
  • Build the source distribution (.tar.gz)
  • Collect everything into dist-release/
  • Verify all distributions with twine check

5. Upload to PyPI

Option A: Test Upload First (Recommended)

python -m twine upload --repository testpypi dist-release/*

Then verify at: https://test.pypi.org/project/islenska/

Option B: Direct Production Upload

python -m twine upload dist-release/*

You'll be prompted for your PyPI credentials (or use API token).

6. Verify Release

Expected Wheel Artifacts

For version 1.1.0, expect approximately 9 wheels:

Linux (x86_64):

  • islenska-1.1.0-cp39-abi3-manylinux_2_17_x86_64.whl
  • islenska-1.1.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.whl
  • islenska-1.1.0-pp310-pypy310_pp73-manylinux_2_17_x86_64.whl

macOS (x86_64 + arm64):

  • islenska-1.1.0-cp39-abi3-macosx_10_9_x86_64.whl
  • islenska-1.1.0-cp39-abi3-macosx_11_0_arm64.whl
  • PyPy wheels for both architectures

Windows (AMD64):

  • islenska-1.1.0-cp39-abi3-win_amd64.whl
  • PyPy wheels

Source:

  • islenska-1.1.0.tar.gz

Troubleshooting

Build Failed

Check the GitHub Actions logs for errors. Common issues:

  • C++ compilation errors
  • Missing dependencies in CI
  • Test failures

Twine Upload Fails

  • Ensure you have PyPI credentials configured
  • Use API token instead of password (more secure)
  • Check network connectivity

Wrong Wheels Downloaded

  • Verify the run ID corresponds to the correct tag
  • Re-run the workflow if needed: gh workflow run wheels.yml --ref 1.1.0

Post-Release

  1. Announce the release (if applicable)
  2. Update documentation with new features
  3. Monitor PyPI download stats
  4. Watch for user-reported issues

Version Numbering

Follow semantic versioning (semver):

  • Major (2.0.0): Breaking API changes
  • Minor (1.1.0): New features, backward compatible
  • Patch (1.0.5): Bug fixes only