Skip to content

docs(core): move release process from CONTRIBUTING.md to AGENTS.md#846

Merged
groksrc merged 1 commit into
mainfrom
docs/release-process-canonical-command
May 23, 2026
Merged

docs(core): move release process from CONTRIBUTING.md to AGENTS.md#846
groksrc merged 1 commit into
mainfrom
docs/release-process-canonical-command

Conversation

@groksrc
Copy link
Copy Markdown
Member

@groksrc groksrc commented May 23, 2026

Summary

  • Moves the ## Release Process section out of CONTRIBUTING.md (which is read by FOSS contributors, who don't cut releases) and into AGENTS.md under ## CODEBASE DEVELOPMENT, alongside the rest of the maintainer-facing operational guidance.
  • Rewrites the content to point at the canonical just release / just beta recipes instead of bare git tag, and explicitly warns against tagging by hand.

Why

The previous CONTRIBUTING.md text documented stable releases as:

git tag v0.13.0 && git push origin v0.13.0

…and claimed "no manual version bumping required". Both are wrong. The just release recipe is the canonical command — it bumps __version__ in src/basic_memory/__init__.py and "version" in server.json (MCP registry metadata) before tagging, and runs lint + typecheck pre-flight.

A bare git tag leaves package metadata correct (uv-dynamic-versioning derives PyPI/Homebrew version from the tag) but basic-memory --version reports 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.md now:

  • Documents just release vX.Y.Z / just beta vX.Y.Zb1 as the entry points
  • Lists what the recipe does step by step
  • Explicitly calls out the do-not-tag-by-hand trap with the v0.21.2 incident as context
  • References .claude/commands/release/release.md for the full runbook including post-release tasks (docs site, basicmachines.co, MCP registry)

Test plan

  • AGENTS.md renders correctly (markdown only, no broken refs)
  • CONTRIBUTING.md still flows naturally — ## Release Process removed cleanly, ## Creating Issues now follows ## Testing Guidelines directly

🤖 Generated with Claude Code

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>
@groksrc groksrc merged commit d4ed02b into main May 23, 2026
23 of 24 checks passed
@groksrc groksrc deleted the docs/release-process-canonical-command branch May 23, 2026 19:00
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 23, 2026

PR Review: docs(core): move release process from CONTRIBUTING.md to AGENTS.md

  • Gather context and understand the request
  • Read changed files (AGENTS.md, CONTRIBUTING.md)
  • Apply team checklist
  • Post review summary

This is a documentation-only PR. No code changes, so code-specific checklist items are N/A.

Team Checklist Results

Code Quality & Standards

  • Follows Basic Memory's coding conventions in CLAUDE.md — docs-only, conventions N/A
  • No commented-out code blocks — N/A, docs only
  • CLAUDE.md/AGENTS.md updated ✅ — this IS the AGENTS.md update

Testing & Documentation

  • Documentation updated — the primary purpose of this PR
  • N/A — no new functions, tests, MCP tools, or coverage to check (docs-only change)

Security & Performance

  • No hardcoded secrets or credentials
  • No sensitive data in logs or commits

Compatibility

  • No emojis or unicode in console/log output (docs use em-dashes, which is fine for markdown)

Review Summary

Verdict: ✅ Clean, well-motivated docs PR. Approved.

What's correct:

  • The motivation is solid and concrete: the v0.21.2 → v0.21.3 re-cut incident caused by a bare git tag is exactly the kind of incident context that makes a warning stick.
  • CONTRIBUTING.md is the right place for FOSS contributor onboarding; release mechanics belong in maintainer-facing AGENTS.md. The restructuring is correct.
  • The new section in AGENTS.md (lines 256–279) is accurate, complete, and actionable:
    • Documents just release vX.Y.Z and just beta vX.Y.Zb1 as entry points
    • Lists what the recipe does step-by-step
    • Explicitly calls out the bare-tag trap with the real incident as context
    • References .claude/commands/release/release.md for the full runbook
  • CONTRIBUTING.md still flows naturally — ## Creating Issues now follows ## Testing Guidelines directly with no awkward gap.

Minor observations (not blocking, PR is already merged):

  • The hardcoded version example (v0.21.3) in the ### Release Process section will drift as new releases are cut. It's fine as a static illustration — just something to be aware of if the section is ever refreshed.
  • The CONTRIBUTING.md test commands (just test-unit, just test-int) differ slightly from the canonical commands in AGENTS.md (just test-unit-sqlite, just test-unit-postgres). That's pre-existing drift unrelated to this PR, but worth a follow-up cleanup.

View job run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant