-
Notifications
You must be signed in to change notification settings - Fork 274
112 lines (97 loc) · 3.65 KB
/
commit-message-check.yml
File metadata and controls
112 lines (97 loc) · 3.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
name: Commit Message Check
on:
pull_request:
types: [opened, edited, reopened, synchronize, labeled, unlabeled]
permissions:
contents: read
pull-requests: read
jobs:
pr-title:
name: Validate PR title (required)
runs-on: ubuntu-latest
if: github.event.pull_request.draft == false
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Validate PR title
uses: actions/github-script@v7
with:
script: |
const { validateCommitMessage } = require('./.github/scripts/commit-message-check.js');
const pr = context.payload.pull_request;
const labels = (pr.labels || []).map((l) => l.name);
if (labels.includes('commit-message-exception')) {
core.notice('Bypassing PR title check — label: commit-message-exception');
return;
}
const result = validateCommitMessage(pr.title);
if (!result.valid) {
const lines = [
'## PR title does not follow conventional-commit format',
'',
'Expected: `<emoji> <type>[(<scope>)][!]: <description>`',
'',
'**Errors:**',
...result.errors.map((e) => `- ${e}`),
'',
'See `.github/prompts/conventional-commit.prompt.md` for the full spec.',
];
core.setFailed(lines.join('\n'));
}
commit-messages:
name: Validate commit messages (hygiene)
runs-on: ubuntu-latest
if: github.event.pull_request.draft == false
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Validate commits
uses: actions/github-script@v7
with:
script: |
const { validateCommitMessage } = require('./.github/scripts/commit-message-check.js');
const pr = context.payload.pull_request;
const labels = (pr.labels || []).map((l) => l.name);
if (labels.includes('commit-message-exception')) {
core.notice('Bypassing commit message check — label: commit-message-exception');
return;
}
const commits = await github.paginate(github.rest.pulls.listCommits, {
owner: context.repo.owner,
repo: context.repo.repo,
pull_number: pr.number,
per_page: 100,
});
const failures = [];
for (const c of commits) {
const msg = c.commit.message;
const result = validateCommitMessage(msg, {requireEmoji: false});
if (result.skipped) continue;
if (!result.valid) {
const sha = c.sha.slice(0, 7);
failures.push(`\`${sha}\`: ${result.errors.join('; ')}`);
}
}
if (failures.length > 0) {
const lines = [
`## ${failures.length} commit message(s) violate conventional-commit format`,
'',
...failures.map((f) => `- ${f}`),
'',
'> This is a hygiene gate. Fix via interactive rebase or amend.',
'> Add label `commit-message-exception` to bypass.',
];
core.setFailed(lines.join('\n'));
}
commit-message-tests:
name: Unit tests for commit-message-check
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '24'
- name: Run tests
run: node --test .github/scripts/commit-message-check.test.js