Repository navigation
295 lines (251 loc) · 11.4 KB
/
Copy pathpr-labeler.yml
File metadata and controls
295 lines (251 loc) · 11.4 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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
name: PR Labeler
on:
pull_request:
types: [opened, synchronize, reopened]
concurrency:
group: pr-labeler-${{ github.event.pull_request.number }}
cancel-in-progress: true
permissions:
contents: read
pull-requests: write
jobs:
label:
name: Auto Label PR
runs-on: ubuntu-latest
# Security: Prevent fork PRs from modifying labels (they don't have write access)
if: github.event.pull_request.head.repo.full_name == github.repository
timeout-minutes: 5
steps:
- name: Label PR
uses: actions/github-script@v8
with:
retries: 3
retry-exempt-status-codes: 400,401,403,404,422
script: |
// ═══════════════════════════════════════════════════════════════
// CONFIGURATION - Single source of truth for all settings
// ═══════════════════════════════════════════════════════════════
const CONFIG = {
// Size thresholds (lines changed)
SIZE_THRESHOLDS: {
XS: 10,
S: 100,
M: 500,
L: 1000
},
// Conventional commit type mappings
TYPE_MAP: Object.freeze({
'feat': 'feature',
'fix': 'bug',
'docs': 'documentation',
'refactor': 'refactor',
'test': 'test',
'ci': 'ci',
'chore': 'chore',
'perf': 'performance',
'style': 'style',
'build': 'build'
}),
// Area detection paths
AREA_PATHS: Object.freeze({
frontend: 'apps/desktop/',
ci: '.github/'
}),
// Label definitions
LABELS: Object.freeze({
SIZE: ['size/XS', 'size/S', 'size/M', 'size/L', 'size/XL'],
AREA: ['area/frontend', 'area/ci']
}),
// Pagination
MAX_FILES_PER_PAGE: 100
};
// ═══════════════════════════════════════════════════════════════
// HELPER FUNCTIONS - Small, focused, single responsibility
// ═══════════════════════════════════════════════════════════════
/**
* Safely parse conventional commit type from PR title
* @param {string} title - PR title
* @returns {{type: string|null, isBreaking: boolean}}
*/
function parseConventionalCommit(title) {
if (!title || typeof title !== 'string') {
return { type: null, isBreaking: false };
}
// Limit input length to prevent ReDoS attacks
const safeTitle = title.slice(0, 200);
const match = safeTitle.match(/^(\w{1,20})(\([^)]{0,50}\))?(!)?:/);
if (!match) {
return { type: null, isBreaking: false };
}
return {
type: match[1].toLowerCase(),
isBreaking: match[3] === '!'
};
}
/**
* Determine size label based on lines changed
* @param {number} totalLines - Total lines changed
* @returns {string} Size label
*/
function determineSizeLabel(totalLines) {
const { SIZE_THRESHOLDS } = CONFIG;
if (totalLines < SIZE_THRESHOLDS.XS) return 'size/XS';
if (totalLines < SIZE_THRESHOLDS.S) return 'size/S';
if (totalLines < SIZE_THRESHOLDS.M) return 'size/M';
if (totalLines < SIZE_THRESHOLDS.L) return 'size/L';
return 'size/XL';
}
/**
* Detect areas affected by file changes
* @param {Array} files - List of changed files
* @returns {{frontend: boolean, ci: boolean}}
*/
function detectAreas(files) {
const areas = { frontend: false, ci: false };
const { AREA_PATHS } = CONFIG;
for (const file of files) {
const path = file.filename || '';
if (path.startsWith(AREA_PATHS.frontend)) areas.frontend = true;
if (path.startsWith(AREA_PATHS.ci)) areas.ci = true;
}
return areas;
}
/**
* Determine area label based on detected areas
* @param {{frontend: boolean, ci: boolean}} areas
* @returns {string|null} Area label or null
*/
function determineAreaLabel(areas) {
if (areas.frontend) return 'area/frontend';
if (areas.ci) return 'area/ci';
return null;
}
/**
* Remove labels from PR (with error handling)
* @param {Array} labels - Labels to remove
* @param {number} prNumber - PR number
*/
async function removeLabels(labels, prNumber) {
const { owner, repo } = context.repo;
await Promise.allSettled(labels.map(async (label) => {
try {
await github.rest.issues.removeLabel({
owner,
repo,
issue_number: prNumber,
name: label
});
console.log(` ✓ Removed: ${label}`);
} catch (e) {
// 404 means label wasn't present - that's fine
if (e.status !== 404) {
console.log(` ⚠ Failed to remove ${label}: ${e.message}`);
}
}
}));
}
/**
* Add labels to PR (with error handling)
* @param {Array} labels - Labels to add
* @param {number} prNumber - PR number
*/
async function addLabels(labels, prNumber) {
if (labels.length === 0) return;
const { owner, repo } = context.repo;
try {
await github.rest.issues.addLabels({
owner,
repo,
issue_number: prNumber,
labels
});
console.log(` ✓ Added: ${labels.join(', ')}`);
} catch (e) {
if (e.status === 404) {
core.warning(`One or more labels do not exist. Create them in repository settings.`);
} else {
throw e;
}
}
}
/**
* Fetch PR files with full pagination support
* @param {number} prNumber - PR number
* @returns {Array} List of all files (paginated)
*/
async function fetchPRFiles(prNumber) {
const { owner, repo } = context.repo;
try {
// Use paginate to fetch ALL files, not just first 100
const files = await github.paginate(
github.rest.pulls.listFiles,
{ owner, repo, pull_number: prNumber, per_page: CONFIG.MAX_FILES_PER_PAGE }
);
return files;
} catch (e) {
console.log(` ⚠ Could not fetch files: ${e.message}`);
return [];
}
}
// ═══════════════════════════════════════════════════════════════
// MAIN LOGIC - Orchestrates the labeling process
// ═══════════════════════════════════════════════════════════════
const { owner, repo } = context.repo;
const pr = context.payload.pull_request;
const prNumber = pr.number;
const title = pr.title || '';
console.log(`::group::PR #${prNumber} - Auto-labeling`);
console.log(`Title: ${title.slice(0, 100)}${title.length > 100 ? '...' : ''}`);
console.log(`Action: ${context.payload.action}`);
const labelsToAdd = new Set();
const labelsToRemove = new Set();
// 1. Parse conventional commit type
const { type, isBreaking } = parseConventionalCommit(title);
if (type && CONFIG.TYPE_MAP[type]) {
labelsToAdd.add(CONFIG.TYPE_MAP[type]);
console.log(` 📝 Type: ${type} → ${CONFIG.TYPE_MAP[type]}`);
} else {
console.log(` ℹ️ No conventional commit prefix detected`);
}
if (isBreaking) {
labelsToAdd.add('breaking-change');
console.log(` ⚠️ Breaking change detected`);
}
// 2. Detect areas from changed files
const files = await fetchPRFiles(prNumber);
const areas = detectAreas(files);
const areaLabel = determineAreaLabel(areas);
if (areaLabel) {
labelsToAdd.add(areaLabel);
CONFIG.LABELS.AREA.filter(l => l !== areaLabel).forEach(l => labelsToRemove.add(l));
console.log(` 📁 Area: ${areaLabel.replace('area/', '')}`);
}
// 3. Calculate size label
const totalLines = (pr.additions || 0) + (pr.deletions || 0);
const sizeLabel = determineSizeLabel(totalLines);
labelsToAdd.add(sizeLabel);
CONFIG.LABELS.SIZE.filter(l => l !== sizeLabel).forEach(l => labelsToRemove.add(l));
console.log(` 📏 Size: ${sizeLabel} (${totalLines} lines)`);
console.log('::endgroup::');
// 4. Apply label changes
console.log(`::group::Applying labels`);
// Remove labels that should be replaced (exclude ones we're adding)
const removeList = [...labelsToRemove].filter(l => !labelsToAdd.has(l));
await removeLabels(removeList, prNumber);
// Add new labels
await addLabels([...labelsToAdd], prNumber);
console.log('::endgroup::');
console.log(`✅ PR #${prNumber} labeled successfully`);
// 5. Write job summary
const summaryType = type ? CONFIG.TYPE_MAP[type] || 'unknown' : 'none';
const summaryArea = areaLabel ? areaLabel.replace('area/', '') : 'other';
await core.summary
.addHeading(`PR #${prNumber} Auto-Labels`, 3)
.addTable([
[{ data: 'Category', header: true }, { data: 'Label', header: true }],
['Type', summaryType],
['Area', summaryArea],
['Size', sizeLabel]
])
.addRaw(`\n**Files:** ${files.length} | **Lines:** +${pr.additions || 0} / -${pr.deletions || 0}\n`)
.write();