Skip to content

release-process.md

Latest commit

 

History

History
139 lines (100 loc) · 2.72 KB

release-process.md

File metadata and controls

139 lines (100 loc) · 2.72 KB
Raw

Release process

Eval-kit currently releases through Git tags, not npm.

Consumers depend on tags like:

{
  "@agentic-workflow-kit/eval-kit": "github:agentic-workflow-kit/eval-kit#vX.Y.Z"
}

Release checklist

- [ ] Decide version: patch or minor.
- [ ] Update package.json version.
- [ ] Update CHANGELOG.md.
- [ ] Update docs that mention the current version/tag.
- [ ] Add migration notes for breaking or compatibility-sensitive changes.
- [ ] Run pnpm install if lockfile changes are needed.
- [ ] Run pnpm install --frozen-lockfile.
- [ ] Run pnpm check.
- [ ] Open and merge a release PR.
- [ ] Create an annotated tag on the merge commit.
- [ ] Push the tag.
- [ ] Verify the tag dereferences to the intended commit.
- [ ] Optionally create a GitHub Release with notes.
- [ ] Open consumer bump PRs.

Release PR

Title:

chore(release): v0.1.8

Required changes:

package.json
CHANGELOG.md
docs/reference/release-process.md if process changed
other docs with version references if needed

Verification:

pnpm install --frozen-lockfile
pnpm check
git diff --check

Tagging

After release PR merges:

git checkout main
git pull --ff-only
git rev-parse HEAD

git tag -a v0.1.8 -m "v0.1.8"
git push origin v0.1.8

Verify:

git rev-parse v0.1.8^{}
git show --no-patch --decorate v0.1.8

v0.1.8^{} must point to the release commit. With an annotated tag, git rev-parse v0.1.8 returns the tag object; ^{} dereferences to the commit.

GitHub Release

Recommended but optional while private:

  1. Create a GitHub Release for the tag.
  2. Copy the relevant CHANGELOG.md section.
  3. Include migration notes and consumer bump instructions.

Consumer bump PRs

For each consumer repo:

  1. Update dependency spec:
{
  "@agentic-workflow-kit/eval-kit": "github:agentic-workflow-kit/eval-kit#v0.1.8"
}
  1. Run:
pnpm install
pnpm install --frozen-lockfile
pnpm check
  1. Run consumer smoke commands, for example in technical-design:
pnpm eval:case -- --case case-tiny-laundry-pickup-v1 --candidate evals/cases/case-tiny-laundry-pickup-v1/reference-design.md --run-id verify-eval-kit-v0.1.8
  1. Open a PR with dependency, lockfile, and any compatibility fixes.

When a tag is bad

Do not move the tag.

Create a new patch release:

v0.1.8 -> v0.1.9

Then open consumer bump PRs.

What else releases should include

Besides version and tag, do not forget:

  • changelog entry;
  • migration notes;
  • docs update for changed CLI/config/adapter behavior;
  • GitHub Release notes if using releases;
  • consumer bump PRs;
  • lockfile updates in consumers;
  • tag verification;
  • no npm publish unless a later decision changes release mode.