|
| 1 | +name: PR Standards |
| 2 | + |
| 3 | +on: |
| 4 | + pull_request: |
| 5 | + types: [opened, edited, synchronize] |
| 6 | + |
| 7 | +jobs: |
| 8 | + check-standards: |
| 9 | + if: | |
| 10 | + github.event.pull_request.user.login != 'actions-user' && |
| 11 | + github.event.pull_request.user.login != 'opencode' && |
| 12 | + github.event.pull_request.user.login != 'rekram1-node' && |
| 13 | + github.event.pull_request.user.login != 'thdxr' && |
| 14 | + github.event.pull_request.user.login != 'kommander' && |
| 15 | + github.event.pull_request.user.login != 'jayair' && |
| 16 | + github.event.pull_request.user.login != 'fwang' && |
| 17 | + github.event.pull_request.user.login != 'adamdotdevin' && |
| 18 | + github.event.pull_request.user.login != 'iamdavidhill' && |
| 19 | + github.event.pull_request.user.login != 'opencode-agent[bot]' |
| 20 | + runs-on: ubuntu-latest |
| 21 | + permissions: |
| 22 | + pull-requests: write |
| 23 | + steps: |
| 24 | + - name: Check PR standards |
| 25 | + uses: actions/github-script@v7 |
| 26 | + with: |
| 27 | + script: | |
| 28 | + const pr = context.payload.pull_request; |
| 29 | + const title = pr.title; |
| 30 | +
|
| 31 | + async function addLabel(label) { |
| 32 | + await github.rest.issues.addLabels({ |
| 33 | + owner: context.repo.owner, |
| 34 | + repo: context.repo.repo, |
| 35 | + issue_number: pr.number, |
| 36 | + labels: [label] |
| 37 | + }); |
| 38 | + } |
| 39 | +
|
| 40 | + async function removeLabel(label) { |
| 41 | + try { |
| 42 | + await github.rest.issues.removeLabel({ |
| 43 | + owner: context.repo.owner, |
| 44 | + repo: context.repo.repo, |
| 45 | + issue_number: pr.number, |
| 46 | + name: label |
| 47 | + }); |
| 48 | + } catch (e) { |
| 49 | + // Label wasn't present, ignore |
| 50 | + } |
| 51 | + } |
| 52 | +
|
| 53 | + async function comment(marker, body) { |
| 54 | + const markerText = `<!-- pr-standards:${marker} -->`; |
| 55 | + const { data: comments } = await github.rest.issues.listComments({ |
| 56 | + owner: context.repo.owner, |
| 57 | + repo: context.repo.repo, |
| 58 | + issue_number: pr.number |
| 59 | + }); |
| 60 | + |
| 61 | + const existing = comments.find(c => c.body.includes(markerText)); |
| 62 | + if (existing) return; |
| 63 | + |
| 64 | + await github.rest.issues.createComment({ |
| 65 | + owner: context.repo.owner, |
| 66 | + repo: context.repo.repo, |
| 67 | + issue_number: pr.number, |
| 68 | + body: markerText + '\n' + body |
| 69 | + }); |
| 70 | + } |
| 71 | +
|
| 72 | + // Step 1: Check title format |
| 73 | + const validPrefixes = ['feat:', 'fix:', 'docs:', 'chore:', 'refactor:', 'test:']; |
| 74 | + const hasValidTitle = validPrefixes.some(prefix => title.startsWith(prefix)); |
| 75 | +
|
| 76 | + if (!hasValidTitle) { |
| 77 | + await addLabel('needs:title'); |
| 78 | + await comment('title', `Hey! Your PR title \`${title}\` doesn't follow conventional commit format. |
| 79 | +
|
| 80 | + Please update it to start with one of: |
| 81 | + - \`feat:\` new feature |
| 82 | + - \`fix:\` bug fix |
| 83 | + - \`docs:\` documentation changes |
| 84 | + - \`chore:\` maintenance tasks |
| 85 | + - \`refactor:\` code refactoring |
| 86 | + - \`test:\` adding or updating tests |
| 87 | +
|
| 88 | + See [CONTRIBUTING.md](../blob/dev/CONTRIBUTING.md#pr-titles) for details.`); |
| 89 | + return; |
| 90 | + } |
| 91 | +
|
| 92 | + await removeLabel('needs:title'); |
| 93 | +
|
| 94 | + // Step 2: Check for linked issue (skip for docs/refactor PRs) |
| 95 | + const skipIssueCheck = title.startsWith('docs:') || title.startsWith('refactor:'); |
| 96 | + if (skipIssueCheck) { |
| 97 | + await removeLabel('needs:issue'); |
| 98 | + console.log('Skipping issue check for docs/refactor PR'); |
| 99 | + return; |
| 100 | + } |
| 101 | + const query = ` |
| 102 | + query($owner: String!, $repo: String!, $number: Int!) { |
| 103 | + repository(owner: $owner, name: $repo) { |
| 104 | + pullRequest(number: $number) { |
| 105 | + closingIssuesReferences(first: 1) { |
| 106 | + totalCount |
| 107 | + } |
| 108 | + } |
| 109 | + } |
| 110 | + } |
| 111 | + `; |
| 112 | +
|
| 113 | + const result = await github.graphql(query, { |
| 114 | + owner: context.repo.owner, |
| 115 | + repo: context.repo.repo, |
| 116 | + number: pr.number |
| 117 | + }); |
| 118 | +
|
| 119 | + const linkedIssues = result.repository.pullRequest.closingIssuesReferences.totalCount; |
| 120 | +
|
| 121 | + if (linkedIssues === 0) { |
| 122 | + await addLabel('needs:issue'); |
| 123 | + await comment('issue', `Thanks for your contribution! |
| 124 | +
|
| 125 | + This PR doesn't have a linked issue. All PRs must reference an existing issue. |
| 126 | +
|
| 127 | + Please: |
| 128 | + 1. Open an issue describing the bug/feature (if one doesn't exist) |
| 129 | + 2. Add \`Fixes #<number>\` or \`Closes #<number>\` to this PR description |
| 130 | +
|
| 131 | + See [CONTRIBUTING.md](../blob/dev/CONTRIBUTING.md#issue-first-policy) for details.`); |
| 132 | + return; |
| 133 | + } |
| 134 | +
|
| 135 | + await removeLabel('needs:issue'); |
| 136 | + console.log('PR meets all standards'); |
0 commit comments