Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (26 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 1.68 KB
Raw

Contributing Guide

Publishing

PyPI deployment is automated via .github/workflows/publish.yaml. On each published GitHub Release, CI runs unit and BDD tests, builds the distribution with uv build, and uploads to PyPI using OIDC trusted publishing (no long-lived API tokens in GitHub Secrets).

One-time maintainer setup

Before the first automated publish from this repository, configure a trusted publisher on pypi.org:

Field Value
PyPI project name aptos-sdk
Owner aptos-labs
Repository name aptos-python-sdk
Workflow name publish.yaml
Environment name pypi

Then create a GitHub environment named pypi under Settings → Environments (no secrets required for OIDC).

Releasing a new version

  1. Bump version in pyproject.toml and add a dated section to CHANGELOG.md.
  2. Merge the version bump to main.
  3. Create a GitHub Release from main:
    • Tag: v<version> (must match pyproject.toml, e.g. v0.12.0 for version 0.12.0)
    • Title: v<version>
    • Paste the new CHANGELOG.md section as release notes
  4. Click Publish release. The Publish aptos-sdk to PyPI workflow runs automatically.

To dry-run the pipeline without publishing, run the workflow manually from the Actions tab with Dry run enabled (tests and build only). A manual publish (Dry run disabled) must be dispatched from a v* tag that matches pyproject.toml.

Local build

uv build