Skip to content

RELEASING.md

Latest commit

 

History

History
74 lines (49 loc) · 1.58 KB

RELEASING.md

File metadata and controls

74 lines (49 loc) · 1.58 KB

Releasing agent-actions

Prerequisites

  • Write access to the Muizzkolapo/agent-actions repository
  • PyPI trusted publishing configured (OIDC) — see note below

Steps

1. Prepare the release

# Ensure main is up to date
git checkout main && git pull

# Confirm tests pass
pytest
ruff check .
ruff format --check .

2. Bump the version

Update the version in pyproject.toml:

[project]
version = "X.Y.Z"

Commit and push:

git add pyproject.toml
git commit -m "chore: bump version to X.Y.Z"
git push origin main

3. Tag the release

git tag vX.Y.Z
git push origin vX.Y.Z

Pushing a v* tag triggers the publish.yml workflow, which builds and publishes to PyPI via OIDC trusted publishing.

4. Create a GitHub Release

Go to Releases → Draft a new release, select the tag, and publish. Add a summary of changes.

PyPI Trusted Publishing

The publish.yml workflow uses OIDC — no API tokens needed. Before the first release, ensure the trusted publisher entry exists in the PyPI project settings:

  • Publisher: GitHub Actions
  • Owner: Muizzkolapo
  • Repository: agent-actions
  • Workflow: publish.yml
  • Environment: (leave blank or match the workflow environment name)

If this is not configured before the first publish run, it will silently fail.

Versioning

This project follows Semantic Versioning:

  • MAJOR — breaking changes to the YAML schema or public API
  • MINOR — new features, backwards compatible
  • PATCH — bug fixes, docs, internal changes