Skip to content

RELEASE.md

Latest commit

 

History

History
48 lines (38 loc) · 1.65 KB

RELEASE.md

File metadata and controls

48 lines (38 loc) · 1.65 KB
Raw

Release Checklist

Pythonlings follows Semantic Versioning. Use full MAJOR.MINOR.PATCH versions in package metadata and annotated git tags such as v0.1.0.

Package Name

The distribution name on PyPI is pythonlings; installing it provides the pythonlings console command. Releases before 0.3.0 were published as python-learnings. The PyPI name pylings belongs to an unrelated project — never publish or document it for this repository.

Pre-Release Verification

Run these checks from a clean working tree before tagging:

python -m pytest -q
pythonlings --root tests/fixtures/passing_curriculum verify
python -m build
python -m pip install --force-reinstall dist/pythonlings-*.whl
pythonlings --version
tmp=$(mktemp -d /tmp/pythonlings-release.XXXXXX)
pythonlings init --path "$tmp"
pythonlings --root "$tmp" list
pythonlings --root "$tmp" solution variables1
pythonlings --root "$tmp" reset variables1 --yes

Expected release version for v0.3.0:

pythonlings 0.3.0

Tag And Publish

  1. One-time setup: the PyPI project pythonlings must have a trusted publisher configured (repository abhiksark/pythonlings, workflow publish.yml, environment pypi). For a first release under a new name, add it as a pending publisher on pypi.org before tagging.
  2. Commit the release changes.
  3. Create an annotated tag, for example git tag -a v0.1.0 -m "Release v0.1.0".
  4. Push the branch and tag.
  5. Create a GitHub Release from the tag.
  6. The publish workflow builds the package, checks that the release tag matches pyproject.toml, smoke-tests the installed wheel, then publishes to PyPI through trusted publishing.