Repository navigation
docs: Replace the Nested CHANGELOG.md with a Root-Level One - #23747
Merged
Merged
Conversation
`src/python/pants/CHANGELOG.md` pointed at https://www.pantsbuild.org/docs, which now returns 404. Point it at https://www.pantsbuild.org/versions, which lists each minor release with its changelog and release blog post. The first sentence said release notes are organized by the branch the release came from. They're now one file per minor release series under `docs/notes`, so say that and link the directory. Disclosure: investigated and implemented with Claude.
benjyw
added
the
release-notes:not-required
Contributor
|
I want to get rid of https://www.pantsbuild.org/versions, since we clearly are not good at maintaining it, and it just recapitulates the in-repo release notes. Actually I'm not even sure why we have that deep CHANGELOG.md. I think we should just have a root-level CHANGELOG.md, that links to |
`src/python/pants/CHANGELOG.md` was a pointer to the release notes that's hard to find at that depth. Move it to the repository root and point it at `docs/notes`, where each minor release series has its own notes file, instead of at https://www.pantsbuild.org/versions, which duplicates those notes and has fallen out of date. Disclosure: investigated and implemented with Claude.
jbylund
changed the title
benjyw
approved these changes
Nov 3, 2026
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.
src/python/pants/CHANGELOG.mdonly points readers at the release notes, and few people look for it that deep in the tree. It also linked to https://www.pantsbuild.org/docs, which now returns 404. This moves it to the repository root and points it atdocs/notes, where each minor release series has its own notes file.Disclosure: investigated and implemented with Claude.