Skip to content

RELEASE.md

Latest commit

 

History

History
89 lines (61 loc) · 2.21 KB

RELEASE.md

File metadata and controls

89 lines (61 loc) · 2.21 KB

Release Process

This document describes how to publish a new version of weaver-kernel to PyPI.

Prerequisites

  • Push access to the dgenio/agent-kernel repository.
  • Trusted Publisher configured on PyPI for this repository (see Trusted Publisher setup below).

Steps

1. Bump the version

Update the version field in pyproject.toml:

[project]
version = "0.4.0"

2. Update the changelog

Add a new section to CHANGELOG.md under ## [Unreleased], then rename it to the new version with today's date:

## [0.4.0] - 2026-03-14

### Added
- ...

### Fixed
- ...

3. Commit and tag

Important: Tag only on main after the release commit is merged. The publish workflow triggers on any v* tag push — tagging a non-main commit would publish unreleased code.

git add pyproject.toml CHANGELOG.md
git commit -m "release: v0.4.0"
git tag v0.4.0
git push origin main --tags

4. CI takes over

Pushing the v* tag triggers .github/workflows/publish.yml, which:

  1. Runs the full CI suite (make ci equivalent) as a gate.
  2. Builds the sdist and wheel with python -m build.
  3. Creates a GitHub Release with auto-generated notes and the built artifacts attached.
  4. Publishes to PyPI using Trusted Publisher (OIDC — no API tokens stored).

Monitor the workflow run at: https://github.com/dgenio/agent-kernel/actions/workflows/publish.yml

5. Verify

pip install weaver-kernel==0.3.0

Trusted Publisher Setup

Trusted Publisher uses OpenID Connect (OIDC) so the GitHub Actions workflow can publish to PyPI without storing API tokens as secrets.

To configure it (one-time setup):

  1. Go to https://pypi.org/manage/project/weaver-kernel/settings/publishing/.
  2. Add a new publisher:
    • Owner: dgenio
    • Repository: agent-kernel
    • Workflow name: publish.yml
    • Environment: pypi
  3. Save. The publish.yml workflow will now authenticate automatically.

Version scheme

This project follows Semantic Versioning:

  • PATCH (0.2.x): bug fixes, documentation updates.
  • MINOR (0.x.0): new features, backward-compatible changes.
  • MAJOR (x.0.0): breaking API changes.