pr-standards.yml 4.9 KB

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