Skip to content

docs: document release workflow #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Fango2007 merged 1 commit into from
Jun 22, 2026
Merged

docs: document release workflow #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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.
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading