docs: state what changelog, breaking, and diff each cover#184
Merged
Conversation
The changelog action was described as outputting "all changes", which is not what it does: documentation-only edits such as descriptions and examples are not reported by any check. Name the boundary consistently across the three actions: changelog shows the changes that can affect API consumers; breaking shows the changes that break existing API clients; diff shows the full diff of the API definition, including documentation-only edits. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
The changelog action was described as outputting "all changes (breaking and non-breaking)". That overstates it: documentation-only edits, such as descriptions and examples, are not reported by any check, so a reader cannot tell when they need the diff action instead.
This names the boundary instead, consistently across the three actions:
Matches the same wording change in oasdiff/oasdiff#1081.
🤖 Generated with Claude Code