|
| 1 | +name: PR Formatting Check |
| 2 | + |
| 3 | +on: |
| 4 | + pull_request: |
| 5 | + types: [opened, edited, reopened, synchronize] |
| 6 | + |
| 7 | +permissions: |
| 8 | + pull-requests: write |
| 9 | + |
| 10 | +jobs: |
| 11 | + check: |
| 12 | + runs-on: ubuntu-latest |
| 13 | + steps: |
| 14 | + - name: Validate PR title and description content |
| 15 | + uses: actions/github-script@v7 |
| 16 | + with: |
| 17 | + script: | |
| 18 | + const title = context.payload.pull_request.title; |
| 19 | + const body = context.payload.pull_request.body; |
| 20 | +
|
| 21 | + const validTitlePrefixes = [ |
| 22 | + 'FEAT:', 'CHORE:', 'FIX:', 'DOC:', 'STYLE:', 'REFACTOR:', 'RELEASE:' |
| 23 | + ]; |
| 24 | +
|
| 25 | + const hasValidPrefix = validTitlePrefixes.some(prefix => title.startsWith(prefix)); |
| 26 | +
|
| 27 | + if (!hasValidPrefix) { |
| 28 | + core.setFailed(`❌ PR title must start with one of the allowed prefixes:\n${validTitlePrefixes.join(', ')}`); |
| 29 | + } |
| 30 | +
|
| 31 | + const azureWorkItemLinkPattern = /https:\/\/sqlclientdrivers\.visualstudio\.com\/[^\/]+\/_workitems\/edit\/\d+/i; |
| 32 | + const hasWorkItemLink = azureWorkItemLinkPattern.test(body); |
| 33 | +
|
| 34 | + if (!hasWorkItemLink) { |
| 35 | + core.setFailed(`❌ PR should contain a valid ADO Work Item ID.\nExpected a hyperlink in the format: https://sqlclientdrivers.visualstudio.com/.../_workitems/edit/<ID>\nPlease ensure the ADO task hyperlink is present in the PR description.`); |
| 36 | + } |
| 37 | + |
| 38 | + // Check if PR description contains a meaningful summary section with actual content |
| 39 | + const summaryPattern = /###\s*Summary\s*\r?\n([\s\S]*?)(\r?\n###|$)/; |
| 40 | + const summaryMatch = body.match(summaryPattern); |
| 41 | + |
| 42 | + let hasValidSummary = false; |
| 43 | + |
| 44 | + if (summaryMatch && summaryMatch[1]) { |
| 45 | + // Extract the summary content |
| 46 | + const summaryContent = summaryMatch[1]; |
| 47 | + |
| 48 | + // Remove all HTML comments including the template placeholder |
| 49 | + const contentWithoutComments = summaryContent.replace(/<!--[\s\S]*?-->/g, ''); |
| 50 | + |
| 51 | + // Remove whitespace and check if there's actual text content |
| 52 | + const trimmedContent = contentWithoutComments.trim(); |
| 53 | + |
| 54 | + // Check if there's at least 10 characters of meaningful content |
| 55 | + hasValidSummary = trimmedContent.length >= 10; |
| 56 | + } |
| 57 | + |
| 58 | + if (!hasValidSummary) { |
| 59 | + core.setFailed(`❌ PR must contain a meaningful summary section with actual text content (minimum 10 characters). |
| 60 | + Please add a clear description under the '### Summary' heading in your PR description.`); |
| 61 | + } |
| 62 | + - name: Add size label based on PR diff |
| 63 | + uses: actions/github-script@v7 |
| 64 | + with: |
| 65 | + script: | |
| 66 | + const pr = context.payload.pull_request; |
| 67 | + const additions = pr.additions; |
| 68 | + const deletions = pr.deletions; |
| 69 | + const totalChanges = additions + deletions; |
| 70 | +
|
| 71 | + // Threshold constants |
| 72 | + const SMALL_PR_THRESHOLD = 100; |
| 73 | + const MEDIUM_PR_THRESHOLD = 500; |
| 74 | +
|
| 75 | + let labelToAdd = ''; |
| 76 | + if (totalChanges < SMALL_PR_THRESHOLD) { |
| 77 | + labelToAdd = 'pr-size: small'; |
| 78 | + } else if (totalChanges < MEDIUM_PR_THRESHOLD) { |
| 79 | + labelToAdd = 'pr-size: medium'; |
| 80 | + } else { |
| 81 | + labelToAdd = 'pr-size: large'; |
| 82 | + } |
| 83 | +
|
| 84 | + // Remove existing size labels if any |
| 85 | + const existingLabels = pr.labels.map(l => l.name); |
| 86 | + const sizeLabels = ['pr-size: small', 'pr-size: medium', 'pr-size: large']; |
| 87 | + for (const label of existingLabels) { |
| 88 | + if (sizeLabels.includes(label)) { |
| 89 | + await github.rest.issues.removeLabel({ |
| 90 | + ...context.repo, |
| 91 | + issue_number: pr.number, |
| 92 | + name: label, |
| 93 | + }); |
| 94 | + } |
| 95 | + } |
| 96 | +
|
| 97 | + // Add new size label |
| 98 | + await github.rest.issues.addLabels({ |
| 99 | + ...context.repo, |
| 100 | + issue_number: pr.number, |
| 101 | + labels: [labelToAdd], |
| 102 | + }); |
| 103 | +
|
| 104 | + console.log(`Added label: ${labelToAdd} (Total changes: ${totalChanges})`); |
0 commit comments