From 87bb81bb557fb8d61a5f2b45527becb680f47e53 Mon Sep 17 00:00:00 2001 From: Rodolphe Lefebvre Date: Mon, 22 Jun 2026 20:30:18 +0200 Subject: [PATCH] docs: document release workflow --- AGENTS.md | 7 +++++++ CHANGELOG.md | 1 + 2 files changed, 8 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 4119380..71563c9 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -32,6 +32,13 @@ - After a branch is merged, resync any related worktrees from the updated base branch before continuing dependent work. - Re-check the Node.js runtime before installs, rebuilds, backend startup, or tests in each worktree. +## Release Workflow + +- For release preparation, read `RELEASING.md` before changing versions, changelog entries, release commits, or tags. +- Use `npm version --workspaces --include-workspace-root --no-git-tag-version` to keep workspace package versions aligned without creating an automatic tag. +- Use annotated release tags (`git tag -a`) so `--follow-tags` and the release workflow pick them up. +- If `npm run release:check` fails with `ELOOP` under `specs/specs/...`, inspect the worktree for a local recursive `specs` symlink before changing tracked files. + ## Static Data and Reference Content - Do not hardcode static data in application code. diff --git a/CHANGELOG.md b/CHANGELOG.md index 5a00219..75d33ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,7 @@ The format is based on Keep a Changelog and this project follows Semantic Versio ### Changed - **Changelog category workflow** — `AGENTS.md` now requires changelog updates to preserve Keep a Changelog category headings and place entries under the appropriate `Added`, `Changed`, `Fixed`, `Removed`, or `Security` section instead of flattening release notes. +- **Release workflow guidance** — `AGENTS.md` now records the release-prep workflow for reading `RELEASING.md`, keeping workspace versions aligned, using annotated tags, and checking local recursive `specs` symlink artifacts before changing tracked files when release checks hit `ELOOP`. - **Run fatal upstream errors** — Run-created benchmark profiles now cancel on the first fatal upstream error, context-window retrieval stops on the first failed item, and HTTP diagnostics preserve upstream provider codes such as `prefill_memory_exceeded`. - **Run template capability filtering** — Run now disables benchmark templates that exceed a selected model's declared context window or require tool calling when the selected model/server is not tool-capable. - **Run audit and functional checks split** — Run now separates pipeline execution health from functional benchmark checks, and treats missing required terms as a visible functional failure when exact matching is disabled.