MAINT: Add PR template content check action #32082
+76
−0
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| --- | ||
| name: 'Verify if PR Template is filled out' | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
|
|
||
| on: | ||
| pull_request_target: | ||
| types: [opened, edited, reopened, ready_for_review] | ||
|
|
||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| GH_REPO: ${{ github.repository }} | ||
| PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }} | ||
|
|
||
| jobs: | ||
| verify-pr-template: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | ||
| with: | ||
| fetch-depth: 0 | ||
| persist-credentials: false | ||
| - name: Read PR Template | ||
| id: template | ||
| uses: juliangruber/read-file-action@271ff311a4947af354c6abcd696a306553b9ec18 # v1.1.8 | ||
| with: | ||
| path: ./.github/PULL_REQUEST_TEMPLATE.md | ||
| # This step is required because the PR body is CRLF (Windows-style line ending) | ||
| - name: Clean PR content | ||
| shell: bash | ||
| id: clean | ||
| env: | ||
| PR_BODY: ${{ github.event.pull_request.body }} | ||
| run: | | ||
| { | ||
| echo 'cleaned<<EOF' | ||
| echo "${PR_BODY}" | tr -d '\r' | ||
| echo EOF | ||
| } >> "$GITHUB_OUTPUT" | ||
|
Comment on lines
+25
to
+41
Member
There was a problem hiding this comment. I do not understand why these are separate steps. They could all go in the bash script. |
||
| - name: Flag as autoclose candidate | ||
| shell: bash | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| TEMPLATE: ${{ steps.template.outputs.content }} | ||
| PR_BODY_CLEAN: ${{ steps.clean.outputs.cleaned }} | ||
| run: | | ||
| label="status: autoclose candidate" | ||
| needs_label=false | ||
|
|
||
| # Condition 1: body identical to template (not filled out) | ||
| if [ "$TEMPLATE" = "$PR_BODY_CLEAN" ]; then | ||
| echo "PR body is identical to the template." | ||
| needs_label=true | ||
| fi | ||
|
|
||
| # Condition 2: any template markdown header missing from the body | ||
| template_headers=$(printf '%s\n' "$TEMPLATE" | { grep -E '^#{1,6}[[:space:]]' || true; } | sort -u) | ||
| body_headers=$(printf '%s\n' "$PR_BODY_CLEAN" | { grep -E '^#{1,6}[[:space:]]' || true; } | sort -u) | ||
|
|
||
| while IFS= read -r header; do | ||
| [ -z "$header" ] && continue | ||
| if ! printf '%s\n' "$body_headers" | grep -qxF -- "$header"; then | ||
| echo "Missing template header: $header" | ||
| needs_label=true | ||
| fi | ||
| done <<< "$template_headers" | ||
|
|
||
| if [ "$needs_label" = true ]; then | ||
| gh pr edit "$PULL_REQUEST_NUMBER" --add-label "$label" | ||
| echo "PR template checks failed. Added label: $label" | ||
| else | ||
| echo "PR template checks passed." | ||
| fi | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There doesn't seem to be any need for the full history.