Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
47 lines (31 loc) · 1.06 KB

DEVELOPMENT.md

File metadata and controls

47 lines (31 loc) · 1.06 KB
Raw

Development Guide — CLI Releases

This repository holds published release artifacts for the charcoal-cli Python package.

Creating a Release

1. Build the Package

From the cli/ directory:

cd cli
python -m build

This creates .tar.gz and .whl files in dist/.

2. Copy Artifacts

cp dist/charcoal_cli-<VERSION>-py3-none-any.whl ../cli-releases/
cp dist/charcoal_cli-<VERSION>.tar.gz ../cli-releases/

3. Create Release Notes

Add a changelog entry in the release notes describing changes since the last release.

4. Publish

Create a GitHub Release with the artifacts attached.

Environment Variables

Variable Description
PYPI_TOKEN (Optional) PyPI API token for publishing to PyPI

Release Checklist

  • Bump version in charcoal_cli/__init__.py
  • Update CHANGELOG.md
  • Build package: python -m build
  • Test the wheel: pip install dist/*.whl
  • Commit and tag: git tag v<version>
  • Push tag: git push origin v<version>
  • Create GitHub Release with artifacts