Skip to content

docs: never edit a changelog - #626

Merged
RonsenbergVI merged 1 commit into
mainfrom
docs/never-edit-changelogs
Nov 15, 2026
Merged

RonsenbergVI merged 1 commit into
mainfrom
docs/never-edit-changelogs

Conversation

@RonsenbergVI

Copy link
Copy Markdown
Collaborator

Pull Request

Type of change

  • Bug fix
  • New feature
  • Refactor / internal cleanup
  • Docs
  • Other:

Description of the changes

AGENTS.md's Pull requests section now forbids editing a changelog: docs/changelog.md, sdk/python/CHANGELOG.md and mcp/CHANGELOG.md belong to release-please, in every pull request, release pull requests included. To change what a release says, change the title of the pull request it comes from.

Motivation for the changes

Release-please writes the changelogs from the squash-commit titles on main. A hand-written entry is either overwritten by the next release pull request or ships a line no commit backs, and fixing a release pull request's CI (as on #625) is exactly when the temptation arises.

Breaking change?

  • No
  • Yes — details below
If yes, fill this in

What breaks:

Before → after:

// before

// after

Migration:

How it was tested

pre-commit run --files AGENTS.md passes.

Performance regression

Checklist

  • Tests pass locally
  • Added/updated tests for the change (or explained why not): docs only, nothing to test
  • Docs updated if behavior changed

Notes for reviewers

@github-actions

Copy link
Copy Markdown

⚪ Nothing to measure

No package a gate benchmarks changed.

Not run, nothing they build on changed: internal/graph, internal/hash, internal/index, internal/query, pkg/server.

@RonsenbergVI
RonsenbergVI merged commit 9d4cfbd into main Nov 15, 2026
11 checks passed
@RonsenbergVI
RonsenbergVI deleted the docs/never-edit-changelogs branch November 15, 2026 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant