feat: add reusable PR description check workflow - #16
Merged
LuWang1983 merged 4 commits intoAug 26, 2026
Conversation
Add callable and local workflows plus Overview validation script so repos can enforce the org PR template via UseAlloy/.github.
|
Related Jira Issue: INFR-6089 Improve pr-description-check GitHub Actions workflow. |
Revert PRs skip description validation in-script so required checks still pass. Add template comment noting the Overview section is validated by CI.
sunnysingh
reviewed
Aug 26, 2026
theworkflow
reviewed
Aug 26, 2026
Clarify Overview template comment, rely on script default for min length, and run the local check only on opened, edited, and reopened PR events.
theworkflow
approved these changes
Aug 26, 2026
| .github/scripts | ||
| token: ${{ secrets.GH_TOKEN }} | ||
|
|
||
| - name: Validate PR description |
Member
There was a problem hiding this comment.
nit: there's a new way to reference actions in the same repo without having to checkout the source code. this would mean wrapping the validate-pr-description.js script in a callable action
- name: Call local action
uses: $/ .github/actions/my-custom-action
with:
my-input: 'hello'
Contributor
Author
There was a problem hiding this comment.
I'll leave this to the next time if necessary. But TIL, this is good to know!
sunnysingh
approved these changes
Aug 26, 2026
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
4 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.
ℹ️ Overview
.github/scripts/validate-pr-description.jsjob.workflow_repository/job.workflow_shaso consumer repos get the pinned script versionRevert ...title orrevert-*branch name); handled in-script so required checks still pass instead of showing skippedopened,edited, andreopenedonly (not label changes)Relates to INFR-6089.
🤖 Coding AI Authorship
Operator directed, reviewed, and revised; AI implemented the workflow and script changes.
🧪 Test Instructions
UseAlloy/.github/.github/workflows/callable.pr-description-check.yaml@<ref>(or enable the local workflow in this repo)Revert ...) — check should pass without requiring Overview contentTest Results
Successful run verified on this PR.
📝 Authoring Guidelines
As the author, I verify that I have:
🚨 Risks
Shared callable workflow — consuming repos must reference this repo (not org-workflows) for the PR description check. Missing
job.workflow_*fails checkout by design.