Skip to content

releases.md

Latest commit

 

History

History
87 lines (68 loc) · 2.85 KB

releases.md

File metadata and controls

87 lines (68 loc) · 2.85 KB
Raw

Releases

This project uses semantic version tags with a v prefix. The repository VERSION file contains the same version without the prefix and is the source of truth for agentctl --version.

0.2 migration notes

Version 0.2 removes the deprecated codexctl wrapper. Use agentctl directly. Image-owned runtime defaults now live below /etc/agentctl: codex, claude, opencode, qwen, and pi. Shared image guidance lives at /etc/agentctl/image.md. agentctl refresh migrates defaults from the legacy /etc/codexctl, /etc/claudectl, /etc/opencodectl, /etc/qwenctl, and /etc/pictl directories, preserves image guidance, and removes the old managed paths. When both layouts contain the same file, the legacy file is migrated before repository-owned defaults are refreshed.

Curated images record immutable build provenance in /etc/agentctl/image-version. The current managed helper version lives in /etc/agentctl/tooling-version and is updated by agentctl refresh. A missing marker identifies an image or container made before this metadata was introduced.

Host-side runtime defaults move into tracked defaults/<runtime>/ directories. Ignored defaults.local/<runtime>/ files can override them for local builds and refreshes without changing tracked project files.

Release checklist

  1. Choose the next semantic version based on user-visible compatibility:

    • patch for backward-compatible fixes
    • minor for backward-compatible features or newly supported runtimes
    • major for intentional breaking changes

  2. Update VERSION on the release branch and include the change in its PR.

  3. Run the repo-local suite:

    bash tests/run-unit-tests.sh

  4. Run the complete host suite on macOS with Apple's supported container version:

    bash tests/run-tests.sh --tier full

  5. Merge the PR through GitHub and update local main with git pull --ff-only.

  6. Verify the release target and version before publishing:

    version="$(cat VERSION)"
test "$(./agentctl --version)" = "agentctl $version"
git status --short --branch
git log -1 --oneline
git ls-remote --exit-code --tags origin "refs/tags/v$version" && {
  echo "Tag v$version already exists" >&2
  exit 1
}

  7. Create and push an annotated tag for the merged main commit:

    git tag -a "v$version" -m "Release v$version" main
git push origin "v$version"

  8. Publish the GitHub release from that verified tag:

    gh release create "v$version" \
  --verify-tag \
  --title "v$version" \
  --generate-notes

  9. Confirm the release and its tag point at the intended commit:

    gh release view "v$version"
git ls-remote --tags origin "refs/tags/v$version"

Do not move or reuse a published version tag. Corrections after publication get a new patch release.