python-cicd-demo

A throwaway Python package whose only purpose is to exercise the release CI/CD + PyPI flow used by scm-python, end to end:

• Version-driven release — the version in pyproject.toml is the single source of truth. Merging a version bump into main triggers a publish.
• CHANGELOG-driven notes — the ## [X.Y.Z] section becomes the GitHub Release body; a missing/empty section fails the release early.
• PyPI Trusted Publishing (OIDC) — no stored API tokens; publishing runs in an approval-gated pypi environment.

Layout

cicd_demo/            # the (flat-layout) package
tests/                # a trivial pytest suite
pyproject.toml        # setuptools build + version of record
CHANGELOG.md          # Keep a Changelog; drives Release notes
.github/workflows/
  test.yml            # CI on develop
  release-python-sdk.yml  # version-triggered release to PyPI

Local use

python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytest
cicd-demo            # prints: Hello, world! (python-cicd-demo 0.1.0)

How to cut a release

1. Edit pyproject.toml → bump version.
2. In CHANGELOG.md, promote ## [Unreleased] to ## [X.Y.Z] - <date>.
3. Commit on develop, open a PR to main, merge it.
4. Approve the run in the pypi environment → it builds, publishes to PyPI, and cuts a vX.Y.Z tag + GitHub Release.

See SETUP.md for the one-time PyPI/GitHub configuration required first.