changelog: validate rst entry line lengths - #4834
Open
dio wants to merge 2 commits into
Open
Conversation
Signed-off-by: Dhi Aurrahman <dio@rockybars.com>
Signed-off-by: Dhi Aurrahman <dio@rockybars.com>
✅ Deploy Preview for nifty-bassi-e26446 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Member
|
@dio thanks for this, will look shortly - other pipelines are taking longer to resolve than i hoped, and i have some python stuff that needs testing already so will look at this when i get to py stuff |
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
2 participants
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
current_dir_pathand removing the obsoleteentries_layoutcheckRationale
Envoy limits YAML lines to 140 characters. Changelog entries are emitted as YAML block scalars with four spaces of indentation, so source RST lines must be at most 136 characters. This is validation-only: automatically wrapping RST roles, links, lists, or literal blocks could change their meaning.
Testing
pants fmt py/envoy.code.check::pants lint py/envoy.code.check::pants check py/envoy.code.check::pants test py/envoy.code.check::envoy.code.check --check changelogagainst an Envoy checkout, confirming overlong entries fail and wrapped entries passFollow-up
After this change is released, an Envoy follow-up will update the
envoy-code-checkdependency, wrap the existing overlong RST entries, and runbazel test //tools/code:check_test. That follow-up will complete envoyproxy/envoy#46148.Part of envoyproxy/envoy#46148.
AI assistance was used to analyze the code, implement the change, and prepare tests. The submitter reviewed and verified the resulting changes.