ci: add workflow to validate PR description sections#1947
Open
bearomorphism wants to merge 1 commit intomasterfrom
Open
ci: add workflow to validate PR description sections#1947bearomorphism wants to merge 1 commit intomasterfrom
bearomorphism wants to merge 1 commit intomasterfrom
Conversation
Checks that PR descriptions include the required sections from the template: Description, Checklist, Expected Behavior, and Steps to Test. - Triggers on opened, edited, reopened, and ready_for_review - Skips draft PRs and bot accounts (dependabot, renovate) - Uses line-anchored regex to match section headers - Additional Context section is intentionally optional Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1947 +/- ##
=======================================
Coverage 98.23% 98.23%
=======================================
Files 61 61
Lines 2772 2772
=======================================
Hits 2723 2723
Misses 49 49 ☔ View full report in Codecov by Sentry. |
Lee-W
approved these changes
May 8, 2026
Member
Lee-W
left a comment
Lee-W
left a comment
There was a problem hiding this comment.
I'm ok with it but a bit not sure whehter rwe really need to enforce it this strict
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.
Description
Add a GitHub Actions workflow that validates PR descriptions contain the required sections from the PR template.
Required sections:
Additional Context is intentionally optional.
Checklist
Was generative AI tooling used to co-author this PR?
Generated-by: GitHub Copilot following the guidelines
Code Changes
uv run poe alllocally to ensure this change passes linter check and testsDocumentation Changes
N/A - CI workflow only.
Expected Behavior
PRs missing required description sections (Description, Checklist, Expected Behavior, Steps to Test) will fail the check with a clear message listing the missing sections.
Draft PRs and bot PRs (dependabot, renovate) are skipped.
Steps to Test This Pull Request
Additional Context
Validation results
validate-prpassed ✅validate-prfailed ❌ with:PR description is missing required sections: Description, Checklist, Expected Behavior, Steps to Test This Pull Request