ci: add workflow to validate PR description sections#1947
ci: add workflow to validate PR description sections#1947bearomorphism 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
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
|
Maybe overkill. I just wanted to make sure everyone follows the contribution guideline. |
|
I think it's a bit too strict, a human may feel discouraged to fill everything, while an AI would read and fill everything. I had some PR's where the template didn't apply (e.g: ci pr), and just filling it for the sake of filling, it feels like bureaucracy 😅 |
|
Agree. Now a good enough AI should follow the guidelines. I already mention the docs in AGENTS.md. Let's close this PR. |
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