Skip to content

RELEASING.md

Latest commit

 

History

History
92 lines (69 loc) · 3.19 KB

RELEASING.md

File metadata and controls

92 lines (69 loc) · 3.19 KB

Releasing

This project follows the ACP schema version published by agentclientprotocol/agent-client-protocol. Each Go release should align with a specific schema tag so that the generated code, helper APIs, and library version remain in sync.

Prerequisites

  • Go 1.21 or newer.
  • make, curl, and git in your PATH.
  • Nix is required for make fmt and make check (they invoke nix fmt and nix flake check). Use nix develop or an equivalent environment before running these targets.
  • The repository must have an Actions secret named ANTHROPIC_API_KEY so the release-notes workflow can update GitHub Release bodies after publication.

Bump the Schema Version

  1. Decide which upstream ACP schema tag to adopt (for example v0.4.3).
  2. Update schema/version and regenerate code. There are two supported ways to do this:

Option A: Use the release helper

make release VERSION=0.4.3

The helper performs the following steps:

  • writes the requested number to schema/version
  • runs make version to download the new schema files and regenerate Go code
  • runs make fmt, make test, and make check
  • asserts that schema/version and version now match

If any command fails, fix the issue and rerun the helper. The target does not create commits or tags; it just prepares the tree.

Option B: Run the steps manually

printf '0.4.3\n' > schema/version
make version
make fmt
GOCACHE=$(pwd)/.gocache make test
make check
cmp -s schema/version version

make version downloads the schema files for the requested ACP tag, regenerates all Go code, and formats the repository with gofumpt. The cmp command is a lightweight guard that ensures both schema/version and the top-level version file agree before you publish.

Review and Commit

  1. Inspect the changes: git status and git diff should show updated schema files, generated Go code, and the version files.
  2. Commit with a descriptive message such as release: v0.4.3.
  3. Push the branch to GitHub and open a pull request if review is required.

Tag and Publish

  1. Tag the release commit with a Go-compatible tag:

    git tag v0.4.3
git push origin v0.4.3

  2. Create a GitHub release for the tag. Include a summary of notable changes and reference the upstream ACP schema version.

After the GitHub release is published, CI runs communique and replaces the release body with generated notes. The workflow requires a v* release tag and the ANTHROPIC_API_KEY Actions secret.

Consumers rely on the vX.Y.Z semver tag for go get, so ensure the tag is pushed before announcing the release.

Additional Notes

  • If the new schema introduces breaking changes, update examples and docs in the same commit.
  • Release-note automation updates GitHub Release bodies only; it does not maintain a CHANGELOG.md.
  • The helper uses a repository-local Go build cache (.gocache) to avoid sandbox restrictions in CI and local development. You can delete it with rm -rf .gocache if needed.
  • make clean removes the downloaded schema files and the version file; rerun the release steps afterwards if you invoke it.