Repository navigation
Enforce Description section in PR body with optional flag - #19
Merged
Merged
Conversation
github-actions
Bot
added
do-not-merge/kind-invalid
release-note
kind/feature
and removed
do-not-merge/kind-invalid
labels
timflannagan
force-pushed
the
chore/reject-empty-descriptions
branch
from
October 31, 2025 18:32
da9ae91 to
e7c9bad
Compare
Adds validation to ensure PRs include a non-empty # Description section. Configurable via enforce_description input (default: true). Invalid PRs receive do-not-merge/description-invalid label. Signed-off-by: timflannagan <timflannagan@gmail.com>
timflannagan
force-pushed
the
chore/reject-empty-descriptions
branch
from
October 31, 2025 18:34
e7c9bad to
17c4997
Compare
Signed-off-by: timflannagan <timflannagan@gmail.com>
timflannagan
force-pushed
the
chore/reject-empty-descriptions
branch
from
October 31, 2025 18:42
16403a3 to
bb9da91
Compare
GitHub returns PR bodies with \r\n (CRLF) line endings, but the regex uses ^# in multiline mode which only matches after \n. This caused the Description regex to fail to match. Fixed by normalizing all \r\n to \n before processing. Signed-off-by: timflannagan <timflannagan@gmail.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
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.
Description
Adds validation to ensure PRs include a non-empty # Description section.
Configurable via enforce_description input (default: true).
Invalid PRs receive do-not-merge/description-invalid label.
Change Type
/kind feature
Changelog
Additional Notes