Skip to content

RELEASING.md

Latest commit

 

History

History
57 lines (47 loc) · 2.53 KB

RELEASING.md

File metadata and controls

57 lines (47 loc) · 2.53 KB
Raw

Releasing pytest-gpu-proof

Publishing runs through GitHub Actions OIDC trusted publishing — no PyPI tokens are stored anywhere. The two lanes are separate workflow files, so a TestPyPI dry-run never shows (or touches) a PyPI job:

  • TestPyPI — .github/workflows/publish-testpypi.yml, manual workflow_dispatch only.
  • PyPI — .github/workflows/publish.yml, automatic on a published GitHub release only.

Both lanes build sdist + wheel, run twine check --strict, and smoke-test the wheel (CLI entry point, import, pytest plugin registration) before uploading.

One-time setup (repo owner, web UI)

  1. PyPI (pypi.org → account → Publishing → "Add a new pending publisher"):
    • PyPI Project Name: pytest-gpu-proof
    • Owner: A2R-Lab, Repository: pytest-gpu-proof
    • Workflow name: publish.yml
    • Environment: pypi
  2. TestPyPI (test.pypi.org, same form):
    • Workflow name: publish-testpypi.yml ← note: NOT publish.yml
    • Environment: testpypi
  3. GitHub (repo → Settings → Environments): create environments pypi and testpypi. Strongly recommended: add yourself as a required reviewer on pypi — every real publish then waits for your explicit approval click, as defense-in-depth on top of the release-only trigger.

The first trusted-publisher upload CREATES the project on (Test)PyPI and registers the name — no separate name registration step.

Per release

  1. Update version in pyproject.toml and retitle the unreleased section in CHANGELOG.md with the date. Commit via the normal branch → PR → CI green → merge flow.
  2. Dry run: Actions → Publish (TestPyPI) → "Run workflow", then pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pytest-gpu-proof in a scratch venv and run gpu-proof --help. (TestPyPI never accepts the same version twice — a duplicate-version error on a re-run is expected and harmless.)
  3. Tag + release: 
    git tag v0.X.Y && git push origin v0.X.Y
gh release create v0.X.Y --title "v0.X.Y" --generate-notes
    The release event runs the Publish workflow → PyPI (pausing for your environment approval if configured).
  4. Sanity: pip install pytest-gpu-proof==0.X.Y in a scratch venv.

Versioning

Pre-1.0 SemVer: patch = fixes, minor = features or breaking changes (called out in the CHANGELOG). Consumers pinning the git submodule are unaffected by PyPI releases; keep the two install paths (git submodule, PyPI) documented in the README.