|
| 1 | +name: PR Body Validation |
| 2 | + |
| 3 | +on: |
| 4 | + pull_request_target: |
| 5 | + types: [opened, edited, synchronize, reopened] |
| 6 | + |
| 7 | +jobs: |
| 8 | + check-pr-content: |
| 9 | + runs-on: ubuntu-latest |
| 10 | + permissions: |
| 11 | + pull-requests: write |
| 12 | + |
| 13 | + steps: |
| 14 | + - name: Checkout code |
| 15 | + uses: actions/checkout@v4 |
| 16 | + |
| 17 | + - name: Check PR content |
| 18 | + uses: actions/github-script@v7 |
| 19 | + with: |
| 20 | + github-token: ${{ secrets.GITHUB_TOKEN }} |
| 21 | + script: | |
| 22 | + const pr = context.payload.pull_request; |
| 23 | + const prBody = pr.body || ''; |
| 24 | + |
| 25 | + let missingItems = []; |
| 26 | + |
| 27 | + // Helper function to extract content between section headers |
| 28 | + function extractSectionContent(content, sectionHeader) { |
| 29 | + const regex = new RegExp(`\\*\\*${sectionHeader}\\*\\*(.*?)(?=\\*\\*|$)`, 's'); |
| 30 | + const match = content.match(regex); |
| 31 | + if (!match) return ''; |
| 32 | + |
| 33 | + // Remove HTML comments and trim whitespace |
| 34 | + return match[1].replace(/<!--[\s\S]*?-->/g, '').trim(); |
| 35 | + } |
| 36 | + |
| 37 | + // Helper function to check if content is meaningful |
| 38 | + function hasMeaningfulContent(content) { |
| 39 | + // Remove HTML comments, markdown symbols, and extra whitespace |
| 40 | + const cleanContent = content |
| 41 | + .replace(/<!--[\s\S]*?-->/g, '') |
| 42 | + .replace(/[#*\[\]()_]/g, '') |
| 43 | + .trim(); |
| 44 | + return cleanContent.length >= 3; // Requiring at least 3 characters |
| 45 | + } |
| 46 | + |
| 47 | + // Check for issue links |
| 48 | + const issueRegex = /(closes|related to)\s+#\d+/i; |
| 49 | + if (!issueRegex.test(prBody)) { |
| 50 | + missingItems.push('issue reference'); |
| 51 | + } |
| 52 | + |
| 53 | + // Check for kind of change |
| 54 | + const changeContent = extractSectionContent(prBody, 'What kind of change does this PR introduce\\?'); |
| 55 | + if (!hasMeaningfulContent(changeContent)) { |
| 56 | + missingItems.push('kind of change description'); |
| 57 | + } |
| 58 | + |
| 59 | + // Check for unchecked items in checklist |
| 60 | + const checklistMatch = prBody.match(/# Checklist([\s\S]*?)(?=(?:#|$))/); |
| 61 | + if (checklistMatch && checklistMatch[1].includes('- [ ]')) { |
| 62 | + missingItems.push('completed checklist items'); |
| 63 | + } |
| 64 | + |
| 65 | + // Get current labels |
| 66 | + const { data: currentLabels } = await github.rest.issues.listLabelsOnIssue({ |
| 67 | + owner: context.repo.owner, |
| 68 | + repo: context.repo.repo, |
| 69 | + issue_number: context.issue.number |
| 70 | + }); |
| 71 | + |
| 72 | + const hasNeedsInfoLabel = currentLabels.some(label => label.name === 'needs-info'); |
| 73 | + |
| 74 | + if (missingItems.length > 0) { |
| 75 | + // If there are missing items, add comment and label |
| 76 | + const missingItemsList = missingItems.join(', '); |
| 77 | + const comment = `Hi @${pr.user.login}! Thanks a lot for your contribution! |
| 78 | + |
| 79 | + I noticed that the following required information is missing or incomplete: ${missingItemsList} |
| 80 | +
|
| 81 | + Please update the PR description to include this information. You can find placeholders in the PR template for these items. |
| 82 | +
|
| 83 | + Thanks a lot!`; |
| 84 | + |
| 85 | + await github.rest.issues.createComment({ |
| 86 | + owner: context.repo.owner, |
| 87 | + repo: context.repo.repo, |
| 88 | + issue_number: context.issue.number, |
| 89 | + body: comment |
| 90 | + }); |
| 91 | + |
| 92 | + // Add needs-info label if not already present |
| 93 | + if (!hasNeedsInfoLabel) { |
| 94 | + await github.rest.issues.addLabels({ |
| 95 | + owner: context.repo.owner, |
| 96 | + repo: context.repo.repo, |
| 97 | + issue_number: context.issue.number, |
| 98 | + labels: ['needs-info'] |
| 99 | + }); |
| 100 | + } |
| 101 | + core.setFailed(`The following required information is missing or incomplete: ${missingItemsList}`); |
| 102 | + } else if (hasNeedsInfoLabel) { |
| 103 | + // If all requirements are met and the needs-info label exists, remove it |
| 104 | + await github.rest.issues.removeLabel({ |
| 105 | + owner: context.repo.owner, |
| 106 | + repo: context.repo.repo, |
| 107 | + issue_number: context.issue.number, |
| 108 | + name: 'needs-info' |
| 109 | + }); |
| 110 | + } |
0 commit comments