Skip to content

docs: assert release policy in AGENTS.md to prevent re-adding release-please #161

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
athal7 merged 1 commit into from
Aug 10, 2026
Merged

docs: assert release policy in AGENTS.md to prevent re-adding release-please #161

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
6 changes: 6 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Agent Instructions

## Release policy — read before touching CI/release config

This repo releases via **semantic-release** (`.releaserc.cjs`, `.github/workflows/ci.yml`) — computes the next version from Conventional Commits and publishes directly on push to main, no PR, no committed version file. `package.json`'s committed `version` is a stale placeholder; the npm registry and git tags are the only sources of truth for the release version.

**Do not add `release-please`** (or any tool that proposes a version-bump pull request, or commits a version bump back to the repo). This was tried once (PRs #156–158) and reverted (#160) — it duplicated the existing semantic-release pipeline and both would have fired on every push. If you're considering a release-automation change here, it means changing `.releaserc.cjs`, not adding a second mechanism alongside it.

## Pre-Commit: Documentation Check

Before committing changes, verify documentation is updated to reflect code changes:
Expand Down