Repository navigation
Expand file tree
/
Copy pathaction.yml
More file actions
326 lines (316 loc) · 12.8 KB
/
Copy pathaction.yml
File metadata and controls
326 lines (316 loc) · 12.8 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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
name: "Check PR Requirements"
description: "Validates pull request properties against configurable requirements"
author: "Oto Macenauer"
branding:
icon: "check-circle"
color: "green"
inputs:
# PR data (defaults read the pull_request event; pass explicit values to override)
pr-title:
description: "Pull request title"
required: false
default: ${{ github.event.pull_request.title }}
pr-body:
description: "Pull request body/description"
required: false
default: ${{ github.event.pull_request.body }}
pr-branch:
description: "Source branch name"
required: false
default: ${{ github.event.pull_request.head.ref }}
pr-number:
description: "Pull request number"
required: false
default: ${{ github.event.pull_request.number }}
target-branch:
description: "Target branch name"
required: false
default: ${{ github.event.pull_request.base.ref }}
files-changed:
description: "Number of files changed"
required: false
default: ${{ github.event.pull_request.changed_files }}
additions:
description: "Number of lines added (used with max-lines-changed)"
required: false
default: ${{ github.event.pull_request.additions }}
deletions:
description: "Number of lines deleted (used with max-lines-changed)"
required: false
default: ${{ github.event.pull_request.deletions }}
labels:
description: "Comma-separated list of PR labels"
required: false
default: ${{ join(github.event.pull_request.labels.*.name, ',') }}
pr-author:
description: "PR author login (used with skip-actors to bypass checks for bots)"
required: false
default: ${{ github.event.pull_request.user.login }}
github-token:
description: "GitHub token for API access (used by the release notes check and comment-on-failure)"
required: false
default: ${{ github.token }}
# Check toggles
check-title:
description: "Enable PR title format check"
required: false
default: "true"
check-description:
description: "Enable PR description presence check"
required: false
default: "true"
check-issue-reference:
description: "Enable issue reference check"
required: false
default: "true"
check-release-notes:
description: "Enable release notes presence check (uses AbsaOSS/release-notes-presence-check)"
required: false
default: "false"
check-branch-name:
description: "Enable branch name convention check"
required: false
default: "false"
check-pr-size:
description: "Enable PR size limit check"
required: false
default: "false"
check-label:
description: "Enable label presence check"
required: false
default: "false"
check-target-branch:
description: "Enable target branch validation"
required: false
default: "false"
# Check configuration
title-formats:
description: "Comma-separated allowed title formats, pass if any matches: conventional, issue-number (#123: Title or 123 - Title), custom (uses title-pattern)"
required: false
default: "conventional"
title-types:
description: "Comma-separated allowed conventional commit types (conventional format)"
required: false
default: "feat,fix,docs,style,refactor,perf,test,build,ci,chore,revert"
title-scopes:
description: "Comma-separated allowed scopes (conventional format; empty = any scope allowed)"
required: false
default: ""
title-pattern:
description: "Regex the title must match (custom format)"
required: false
default: ""
title-require-scope:
description: "Require a scope in conventional titles, e.g. feat(api): ..."
required: false
default: "false"
title-max-length:
description: "Maximum title length in characters, applied to every format (empty = unlimited)"
required: false
default: ""
description-min-length:
description: "Minimum PR description length in characters"
required: false
default: "20"
description-required-sections:
description: "Comma-separated headings that must appear in the PR body, e.g. '## Release Notes' (empty = none)"
required: false
default: ""
description-ignore-comments:
description: "Ignore <!-- --> comments (e.g. PR template hints) when checking the description"
required: false
default: "false"
description-require-section-content:
description: "Each required section must be a heading line followed by text before the next heading"
required: false
default: "false"
issue-reference-require-keyword:
description: "Only keyword issue references count, e.g. 'Fixes #123', 'Closes AB#12345'"
required: false
default: "false"
branch-pattern:
description: "Full regex override for valid branch names"
required: false
default: "^(feature|bugfix|hotfix|release|support|chore|docs|ci|dependabot)/[a-zA-Z0-9._/-]+$"
branch-require-ticket:
description: "Require a ticket after the branch prefix, e.g. feature/123-user-login"
required: false
default: "false"
branch-ticket-pattern:
description: "Regex the branch must match when branch-require-ticket is true (default: numeric ticket after prefix, e.g. feature/123-user-login). Override for schemes like feature/PROJ-123-..."
required: false
default: "^[^/]+/[0-9]+-"
max-files-changed:
description: "Maximum number of files changed allowed"
required: false
default: "50"
max-lines-changed:
description: "Maximum number of changed lines (additions + deletions) allowed (empty = no limit)"
required: false
default: ""
required-labels:
description: "Comma-separated list of required labels (empty = at least one label)"
required: false
default: ""
allowed-target-branches:
description: "Comma-separated list of allowed target branches; glob patterns supported, e.g. 'main,support/*'"
required: false
default: "main,master"
annotations:
description: "Emit an error/warning annotation per failed check, shown in the PR checks UI"
required: false
default: "true"
comment-on-failure:
description: "Keep one PR comment with the summary while checks fail and delete it once they pass or are skipped (needs pull-requests: write; set false to opt out)"
required: false
default: "true"
skip-actors:
description: "Comma-separated PR-author logins that bypass all checks (e.g. bots). Empty = no bypass."
required: false
default: ""
skip-labels:
description: "Comma-separated PR labels that bypass all checks. Empty = no bypass."
required: false
default: ""
warn-checks:
description: "Comma-separated check ids whose failures are warnings and do not fail the job"
required: false
default: ""
release-notes-tag:
description: "Tag to look for in PR body for release notes"
required: false
default: "## [Rr]elease [Nn]otes"
release-notes-skip-labels:
description: "Labels that skip the release notes check"
required: false
default: "no RN"
release-notes-skip-placeholders:
description: "Placeholder strings that indicate missing release notes"
required: false
default: "TBD"
outputs:
result:
description: "Overall result: pass or fail"
value: ${{ steps.evaluate.outputs.result }}
pass-count:
description: "Number of checks that passed"
value: ${{ steps.checks.outputs.pass-count }}
fail-count:
description: "Number of checks that failed"
value: ${{ steps.checks.outputs.fail-count }}
warn-count:
description: "Number of checks reported as warnings"
value: ${{ steps.checks.outputs.warn-count }}
total-count:
description: "Total number of checks run"
value: ${{ steps.checks.outputs.total-count }}
failed-checks:
description: "Comma-separated ids of checks that failed (e.g. title,pr-size)"
value: ${{ steps.checks.outputs.failed-checks }}
summary:
description: "Markdown summary of the check results"
value: ${{ steps.checks.outputs.summary }}
skipped:
description: "true when all checks were bypassed by skip-actors or skip-labels"
value: ${{ steps.checks.outputs.skipped }}
skip-reason:
description: "Why the checks were bypassed (empty when not skipped)"
value: ${{ steps.checks.outputs.skip-reason }}
runs:
using: "composite"
steps:
- name: Detect bypass
id: bypass
if: inputs.check-release-notes == 'true'
shell: bash
env:
INPUT_PR_AUTHOR: ${{ inputs.pr-author }}
INPUT_SKIP_ACTORS: ${{ inputs.skip-actors }}
INPUT_SKIP_LABELS: ${{ inputs.skip-labels }}
INPUT_LABELS: ${{ inputs.labels }}
run: bash "${{ github.action_path }}/check.sh" --detect-bypass
# Runs before check.sh, which reports its outcome in the shared summary
- name: Check release notes
id: release-notes
if: inputs.check-release-notes == 'true' && steps.bypass.outputs.bypassed != 'true'
continue-on-error: true
uses: AbsaOSS/release-notes-presence-check@8e586b26a5e27f899ee8590a5d988fd4780a3dbf # v0.4.0
env:
GITHUB_TOKEN: ${{ inputs.github-token }}
with:
github-repository: ${{ github.repository }}
pr-number: ${{ inputs.pr-number || github.event.pull_request.number }}
title: ${{ inputs.release-notes-tag }}
skip-labels: ${{ inputs.release-notes-skip-labels }}
skip-placeholders: ${{ inputs.release-notes-skip-placeholders }}
- name: Run PR checks
id: checks
continue-on-error: true
shell: bash
env:
INPUT_PR_TITLE: ${{ inputs.pr-title }}
INPUT_PR_BODY: ${{ inputs.pr-body }}
INPUT_PR_BRANCH: ${{ inputs.pr-branch }}
INPUT_PR_AUTHOR: ${{ inputs.pr-author }}
INPUT_SKIP_ACTORS: ${{ inputs.skip-actors }}
INPUT_SKIP_LABELS: ${{ inputs.skip-labels }}
INPUT_ANNOTATIONS: ${{ inputs.annotations }}
INPUT_COMMENT_ON_FAILURE: ${{ inputs.comment-on-failure }}
INPUT_TARGET_BRANCH: ${{ inputs.target-branch }}
INPUT_FILES_CHANGED: ${{ inputs.files-changed }}
INPUT_ADDITIONS: ${{ inputs.additions }}
INPUT_DELETIONS: ${{ inputs.deletions }}
INPUT_LABELS: ${{ inputs.labels }}
INPUT_CHECK_TITLE: ${{ inputs.check-title }}
INPUT_CHECK_DESCRIPTION: ${{ inputs.check-description }}
INPUT_CHECK_ISSUE_REFERENCE: ${{ inputs.check-issue-reference }}
INPUT_CHECK_BRANCH_NAME: ${{ inputs.check-branch-name }}
INPUT_CHECK_PR_SIZE: ${{ inputs.check-pr-size }}
INPUT_CHECK_LABEL: ${{ inputs.check-label }}
INPUT_CHECK_TARGET_BRANCH: ${{ inputs.check-target-branch }}
INPUT_CHECK_RELEASE_NOTES: ${{ inputs.check-release-notes }}
INPUT_TITLE_FORMATS: ${{ inputs.title-formats }}
INPUT_TITLE_TYPES: ${{ inputs.title-types }}
INPUT_TITLE_SCOPES: ${{ inputs.title-scopes }}
INPUT_TITLE_PATTERN: ${{ inputs.title-pattern }}
INPUT_TITLE_REQUIRE_SCOPE: ${{ inputs.title-require-scope }}
INPUT_TITLE_MAX_LENGTH: ${{ inputs.title-max-length }}
INPUT_DESCRIPTION_MIN_LENGTH: ${{ inputs.description-min-length }}
INPUT_DESCRIPTION_REQUIRED_SECTIONS: ${{ inputs.description-required-sections }}
INPUT_DESCRIPTION_IGNORE_COMMENTS: ${{ inputs.description-ignore-comments }}
INPUT_DESCRIPTION_REQUIRE_SECTION_CONTENT: ${{ inputs.description-require-section-content }}
INPUT_ISSUE_REFERENCE_REQUIRE_KEYWORD: ${{ inputs.issue-reference-require-keyword }}
INPUT_BRANCH_PATTERN: ${{ inputs.branch-pattern }}
INPUT_BRANCH_REQUIRE_TICKET: ${{ inputs.branch-require-ticket }}
INPUT_BRANCH_TICKET_PATTERN: ${{ inputs.branch-ticket-pattern }}
INPUT_MAX_FILES_CHANGED: ${{ inputs.max-files-changed }}
INPUT_MAX_LINES_CHANGED: ${{ inputs.max-lines-changed }}
INPUT_REQUIRED_LABELS: ${{ inputs.required-labels }}
INPUT_ALLOWED_TARGET_BRANCHES: ${{ inputs.allowed-target-branches }}
INPUT_WARN_CHECKS: ${{ inputs.warn-checks }}
INPUT_RELEASE_NOTES_TAG: ${{ inputs.release-notes-tag }}
INPUT_RELEASE_NOTES_SKIP_LABELS: ${{ inputs.release-notes-skip-labels }}
INPUT_RELEASE_NOTES_OUTCOME: ${{ steps.release-notes.outcome }}
run: bash "$GITHUB_ACTION_PATH/check.sh"
- name: Update PR comment
# Also runs on bypassed runs (result=pass) so a stale failure comment is removed
if: steps.checks.outputs.comment-on-failure == 'true'
continue-on-error: true
shell: bash
env:
GH_TOKEN: ${{ inputs.github-token }}
INPUT_PR_NUMBER: ${{ inputs.pr-number }}
INPUT_RESULT: ${{ steps.checks.outputs.result }}
INPUT_SUMMARY: ${{ steps.checks.outputs.summary }}
run: bash "$GITHUB_ACTION_PATH/comment.sh"
- name: Evaluate results
id: evaluate
shell: bash
env:
CHECKS_OUTCOME: ${{ steps.checks.outcome }}
run: |
if [[ "$CHECKS_OUTCOME" == "failure" ]]; then
echo "result=fail" >> "$GITHUB_OUTPUT"
exit 1
fi
echo "result=pass" >> "$GITHUB_OUTPUT"