docs(core): move release process from CONTRIBUTING.md to AGENTS.md#846
Merged
Conversation
CONTRIBUTING.md is read by FOSS contributors, who do not cut releases. The release process is operational knowledge for maintainers (and agents working on the project), so it belongs in AGENTS.md alongside the rest of the codebase-development guidance. The previous CONTRIBUTING.md text was also actively misleading: it documented stable releases as ``git tag vX.Y.Z && git push origin vX.Y.Z`` and claimed "no manual version bumping required." Both are wrong. The ``just release`` recipe in justfile is the canonical command — it bumps ``__version__`` in ``src/basic_memory/__init__.py`` and ``"version"`` in ``server.json`` (MCP registry metadata) before tagging. A bare ``git tag`` leaves package metadata correct (uv-dynamic-versioning derives it from the tag) but ``basic-memory --version`` reports the previous release, which is what happened with v0.21.2 → v0.21.3. AGENTS.md now documents ``just release`` / ``just beta`` as the entry points, explicitly calls out the do-not-tag-by-hand trap, and points at ``.claude/commands/release/release.md`` for the full runbook including post-release tasks (docs site, basicmachines.co, MCP registry). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Drew Cain <groksrc@gmail.com>
Contributor
PR Review: docs(core): move release process from CONTRIBUTING.md to AGENTS.md
This is a documentation-only PR. No code changes, so code-specific checklist items are N/A. Team Checklist ResultsCode Quality & Standards
Testing & Documentation
Security & Performance
Compatibility
Review SummaryVerdict: ✅ Clean, well-motivated docs PR. Approved. What's correct:
Minor observations (not blocking, PR is already merged):
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
## Release Processsection out ofCONTRIBUTING.md(which is read by FOSS contributors, who don't cut releases) and intoAGENTS.mdunder## CODEBASE DEVELOPMENT, alongside the rest of the maintainer-facing operational guidance.just release/just betarecipes instead of baregit tag, and explicitly warns against tagging by hand.Why
The previous
CONTRIBUTING.mdtext documented stable releases as:…and claimed "no manual version bumping required". Both are wrong. The
just releaserecipe is the canonical command — it bumps__version__insrc/basic_memory/__init__.pyand"version"inserver.json(MCP registry metadata) before tagging, and runs lint + typecheck pre-flight.A bare
git tagleaves package metadata correct (uv-dynamic-versioning derives PyPI/Homebrew version from the tag) butbasic-memory --versionreports the previous release. That's what happened with v0.21.2 → had to re-cut as v0.21.3 today using the proper recipe.AGENTS.mdnow:just release vX.Y.Z/just beta vX.Y.Zb1as the entry points.claude/commands/release/release.mdfor the full runbook including post-release tasks (docs site, basicmachines.co, MCP registry)Test plan
AGENTS.mdrenders correctly (markdown only, no broken refs)CONTRIBUTING.mdstill flows naturally —## Release Processremoved cleanly,## Creating Issuesnow follows## Testing Guidelinesdirectly🤖 Generated with Claude Code