generated from ianlewis/repo-template
-
Notifications
You must be signed in to change notification settings - Fork 0
574 lines (509 loc) · 20.1 KB
/
pre-submit.units.yml
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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
name: tests
on:
push:
branches: [main]
pull_request:
# The branches below must be a subset of the branches above
branches: [main]
workflow_dispatch:
permissions:
contents: read # Needed to check out the repo.
jobs:
# Unit tests for TypeScript code
######################################
ts-tests:
name: TypeScript unit tests
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
with:
node-version: 20
- name: unit tests
run: |
make unit-test
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@6d798873df2b1b8e5846dba6fb86631229fbcb17 # v4.4.0
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: "coverage/cobertura-coverage.xml"
fail_ci_if_error: true
# check-dist for actions
###############################
check-dist:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
with:
node-version: 20
- name: Rebuild the dist/ directory
run: make clean package
- name: Compare the expected and actual dist/ directories
id: diff
run: |
set -euo pipefail
if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then
echo "::error::Detected uncommitted changes after build. See status below:"
echo "::group::git diff"
GIT_PAGER="cat" git diff
echo "::endgroup::"
exit 1
fi
# If dist/ was different from expected, upload the expected version as an artifact
- uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0
if: ${{ failure() && steps.diff.conclusion == 'failure' }}
with:
name: dist
path: dist/
# autogen for license headers
###############################
autogen:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
repository: mbrukman/autogen
ref: 9026b78e17573b5dda4bff79033c352443551dc5
path: autogen
- run: |
echo "${GITHUB_WORKSPACE}/autogen" >> "${GITHUB_PATH}"
- run: make autogen
- name: check diff
run: |
set -euo pipefail
if [ "$(GIT_PAGER="cat" git diff --ignore-space-at-eol | wc -l)" -gt "0" ]; then
echo "::error::Detected license header changes. See status below:"
echo "::group::git diff"
GIT_PAGER="cat" git diff
echo "::endgroup::"
exit 1
fi
# linters
###############################
actionlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- name: actionlint
env:
SHELLCHECK_VERSION: "0.9.0"
SHELLCHECK_CHECKSUM: "700324c6dd0ebea0117591c6cc9d7350d9c7c5c287acbad7630fa17b1d4d9e2f"
ACTIONLINT_VERSION: "1.6.26"
ACTIONLINT_CHECKSUM: "f0294c342af98fad4ff917bc32032f28e1b55f76aedf291886ec10bbed7c12e1"
run: |
set -euo pipefail
# Install shellcheck
curl -sSLo shellcheck.tar.gz "https://github.com/koalaman/shellcheck/releases/download/v${SHELLCHECK_VERSION}/shellcheck-v${SHELLCHECK_VERSION}.linux.x86_64.tar.xz"
if ! echo "${SHELLCHECK_CHECKSUM} shellcheck.tar.gz" | sha256sum --strict --check --status; then
echo "::error::Unexpected checksum for shellcheck: expected '${SHELLCHECK_CHECKSUM}', got '$(sha256sum shellcheck.tar.gz | awk '{ print $1 }')'"
exit 1
fi
tar xf shellcheck.tar.gz
mv "shellcheck-v${SHELLCHECK_VERSION}/shellcheck" /usr/local/bin
# Install actionlint
curl -sSLo actionlint.tar.gz "https://github.com/rhysd/actionlint/releases/download/v${ACTIONLINT_VERSION}/actionlint_${ACTIONLINT_VERSION}_linux_amd64.tar.gz"
if ! echo "${ACTIONLINT_CHECKSUM} actionlint.tar.gz" | sha256sum --strict --check --status; then
echo "::error::Unexpected checksum for actionlint: expected '${ACTIONLINT_CHECKSUM}', got '$(sha256sum actionlint.tar.gz | awk '{ print $1 }')'"
exit 1
fi
tar xf actionlint.tar.gz
mv ./actionlint /usr/local/bin
make actionlint
markdownlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
with:
node-version: 20
- run: make markdownlint
yamllint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- env:
YAMLLINT_VERSION: "1.26.3"
run: |
set -euo pipefail
# Install yamllint
pip install -r requirements.txt --require-hashes
# Run yamllint
make yamllint
eslint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
with:
node-version: 20
- run: make eslint
# e2e tests.
###############################
issue-reopener-basic:
runs-on: ubuntu-latest
outputs:
issue-url: ${{ steps.create-issue.outputs.url }}
permissions:
issues: write
steps:
- name: Checkout action
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
path: "todo-issue-reopener"
# NOTE: We want to call the todo-issue-reopener action from a checkout on
# the default path of GITHUB_WORKSPACE but we don't want the code
# from the action itself to affect the outcome. We move it to /tmp
# so that it outside of the GITHUB_WORKSPACE.
- name: Move checkout to tmp
run: |
mv "${GITHUB_WORKSPACE}/todo-issue-reopener" "/tmp"
- id: create-issue
name: Create closed issue
env:
GH_TOKEN: ${{ github.token }}
PR_URL: ${{ github.event.pull_request.html_url }}
run: |
body=""
if [ "${PR_URL}" != "" ]; then
body="Test issue for commit $PR ${PR_URL}"
else
body="Test issue for commit ${GITHUB_SHA}"
fi
body="${body}
- [Workflow run](https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}/attempts/${GITHUB_RUN_ATTEMPT})"
url=$(gh issue create -R "${GITHUB_REPOSITORY}" --title "issue-reopener-basic pre-submit test issue" --body "${body}" --label "test-issue")
echo "::debug::Closing GitHub issue: ${url}"
gh issue close "${url}"
echo "url=${url}" >> "${GITHUB_OUTPUT}"
- name: Setup mock repo
env:
ISSUE_URL: ${{ steps.create-issue.outputs.url }}
run: |
git init
mkdir test
echo "// TODO(${ISSUE_URL}): still open" > test/test.go
# NOTE: We cannot use dynamic variables or absolute paths.
# Here we must provide a path relative to GITHUB_WORKSPACE so we ensure
# we get back to the root tmp directory no matter what GITHUB_WORKSPACE
# directory is set to.
- name: Run todo-issue-reopener
uses: "./../../../../../../../../../../../tmp/todo-issue-reopener"
- name: Check issue was reopened
env:
GH_TOKEN: ${{ github.token }}
ISSUE_URL: ${{ steps.create-issue.outputs.url }}
run: |
# Ensure the issue was reopened.
state=$(gh issue view "${ISSUE_URL}" --json state | jq -r '.state')
[ "${state}" == "OPEN" ]
# Check that the body contains the right path
# NOTE: Need to get text output in order to get issue comments.
body=$(gh issue view "${ISSUE_URL}" -c)
[[ "${body}" == *"1. [test/test.go:1]"* ]]
issue-reopener-basic-cleanup:
runs-on: ubuntu-latest
needs: issue-reopener-basic
if: ${{ always() }}
permissions:
issues: write
steps:
- env:
ISSUE_URL: ${{ needs.issue-reopener-basic.outputs.issue-url }}
GH_TOKEN: ${{ github.token }}
run: |
# Close the test issue.
gh issue close "${ISSUE_URL}" || true
issue-reopener-path:
runs-on: ubuntu-latest
outputs:
issue-url: ${{ steps.create-issue.outputs.url }}
permissions:
issues: write
steps:
- name: Checkout action
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
path: "todo-issue-reopener"
- id: create-issue
name: Create closed issue
env:
GH_TOKEN: ${{ github.token }}
PR_URL: ${{ github.event.pull_request.html_url }}
run: |
body=""
if [ "${PR_URL}" != "" ]; then
body="Test issue for commit $PR ${PR_URL}"
else
body="Test issue for commit ${GITHUB_SHA}"
fi
body="${body}
- [Workflow run](https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}/attempts/${GITHUB_RUN_ATTEMPT})"
url=$(gh issue create -R "${GITHUB_REPOSITORY}" --title "issue-reopener-path pre-submit test issue" --body "${body}" --label "test-issue")
echo "::debug::Closing GitHub issue: ${url}"
gh issue close "${url}"
echo "url=${url}" >> "${GITHUB_OUTPUT}"
- name: Setup mock repo
env:
ISSUE_URL: ${{ steps.create-issue.outputs.url }}
run: |
git init
mkdir test
echo "// TODO(${ISSUE_URL}): still open" > test/test.go
- uses: ./todo-issue-reopener/
with:
path: "test/"
- env:
GH_TOKEN: ${{ github.token }}
ISSUE_URL: ${{ steps.create-issue.outputs.url }}
run: |
# Ensure the issue was reopened.
state=$(gh issue view "${ISSUE_URL}" --json state | jq -r '.state')
[ "${state}" == "OPEN" ]
# Check that the body contains the right path
# NOTE: Need to get text output in order to get issue comments.
body=$(gh issue view "${ISSUE_URL}" -c)
[[ "${body}" == *"1. [test/test.go:1]"* ]]
issue-reopener-path-cleanup:
runs-on: ubuntu-latest
needs: issue-reopener-path
if: ${{ always() }}
permissions:
issues: write
steps:
- env:
ISSUE_URL: ${{ needs.issue-reopener-path.outputs.issue-url }}
GH_TOKEN: ${{ github.token }}
run: |
# Close the test issue.
gh issue close "${ISSUE_URL}" || true
issue-reopener-dry-run:
runs-on: ubuntu-latest
outputs:
issue-url: ${{ steps.create-issue.outputs.url }}
permissions:
issues: write
steps:
- name: Checkout action
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
path: "todo-issue-reopener"
# NOTE: We want to call the todo-issue-reopener action from a checkout on
# the default path of GITHUB_WORKSPACE but we don't want the code
# from the action itself to affect the outcome. We move it to /tmp
# so that it outside of the GITHUB_WORKSPACE.
- name: Move checkout to tmp
run: |
mv "${GITHUB_WORKSPACE}/todo-issue-reopener" "/tmp"
- id: create-issue
name: Create closed issue
env:
GH_TOKEN: ${{ github.token }}
PR_URL: ${{ github.event.pull_request.html_url }}
run: |
body=""
if [ "${PR_URL}" != "" ]; then
body="Test issue for commit $PR ${PR_URL}"
else
body="Test issue for commit ${GITHUB_SHA}"
fi
body="${body}
- [Workflow run](https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}/attempts/${GITHUB_RUN_ATTEMPT})"
url=$(gh issue create -R "${GITHUB_REPOSITORY}" --title "issue-reopener-dry-run pre-submit test issue" --body "${body}" --label "test-issue")
echo "::debug::Closing GitHub issue: ${url}"
gh issue close "${url}"
echo "url=${url}" >> "${GITHUB_OUTPUT}"
- name: Setup mock repo
env:
ISSUE_URL: ${{ steps.create-issue.outputs.url }}
run: |
git init
mkdir test
echo "// TODO(${ISSUE_URL}): still open" > test/test.go
# NOTE: We cannot use dynamic variables or absolute paths.
# Here we must provide a path relative to GITHUB_WORKSPACE so we ensure
# we get back to the root tmp directory no matter what GITHUB_WORKSPACE
# directory is set to.
- name: Run todo-issue-reopener
uses: "./../../../../../../../../../../../tmp/todo-issue-reopener"
with:
dry-run: true
- name: Check issue is still closed.
env:
GH_TOKEN: ${{ github.token }}
ISSUE_URL: ${{ steps.create-issue.outputs.url }}
run: |
# Ensure the issue was not reopened.
state=$(gh issue view "${ISSUE_URL}" --json state | jq -r '.state')
[ "${state}" == "CLOSED" ]
issue-reopener-dry-run-cleanup:
runs-on: ubuntu-latest
needs: issue-reopener-dry-run
if: ${{ always() }}
permissions:
issues: write
steps:
- env:
ISSUE_URL: ${{ needs.issue-reopener-dry-run.outputs.issue-url }}
GH_TOKEN: ${{ github.token }}
run: |
# Ensure the the test issue is closed even if test fails.
gh issue close "${ISSUE_URL}" || true
issue-reopener-subdir:
runs-on: ubuntu-latest
outputs:
issue-url: ${{ steps.create-issue.outputs.url }}
permissions:
issues: write
steps:
- name: Checkout action
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
path: "todo-issue-reopener"
- id: create-issue
name: Create closed issue
env:
GH_TOKEN: ${{ github.token }}
PR_URL: ${{ github.event.pull_request.html_url }}
run: |
body=""
if [ "${PR_URL}" != "" ]; then
body="Test issue for commit $PR ${PR_URL}"
else
body="Test issue for commit ${GITHUB_SHA}"
fi
body="${body}
- [Workflow run](https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}/attempts/${GITHUB_RUN_ATTEMPT})"
url=$(gh issue create -R "${GITHUB_REPOSITORY}" --title "issue-reopener-subdir pre-submit test issue" --body "${body}" --label "test-issue")
echo "::debug::Closing GitHub issue: ${url}"
gh issue close "${url}"
echo "url=${url}" >> "${GITHUB_OUTPUT}"
- name: Setup mock repo
env:
ISSUE_URL: ${{ steps.create-issue.outputs.url }}
run: |
mkdir -p test/subdir
cd test/
git init
echo "// TODO(${ISSUE_URL}): still open" > subdir/test.go
- name: Run todo-issue-reopener
uses: "./todo-issue-reopener"
with:
path: "test/subdir/"
- env:
GH_TOKEN: ${{ github.token }}
ISSUE_URL: ${{ steps.create-issue.outputs.url }}
run: |
# Ensure the issue was reopened.
state=$(gh issue view "${ISSUE_URL}" --json state | jq -r '.state')
[ "${state}" == "OPEN" ]
# Check that the body contains the right path
# NOTE: Need to get text output in order to get issue comments.
body=$(gh issue view "${ISSUE_URL}" -c)
[[ "${body}" == *"1. [subdir/test.go:1]"* ]]
issue-reopener-subdir-cleanup:
runs-on: ubuntu-latest
needs: issue-reopener-subdir
if: ${{ always() }}
permissions:
issues: write
steps:
- env:
ISSUE_URL: ${{ needs.issue-reopener-subdir.outputs.issue-url }}
GH_TOKEN: ${{ github.token }}
run: |
# Close the test issue.
gh issue close "${ISSUE_URL}" || true
issue-reopener-vanityURLs:
runs-on: ubuntu-latest
outputs:
issue-url: ${{ steps.create-issue.outputs.url }}
permissions:
issues: write
steps:
- name: Checkout action
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
path: "todo-issue-reopener"
# NOTE: We want to call the todo-issue-reopener action from a checkout on
# the default path of GITHUB_WORKSPACE but we don't want the code
# from the action itself to affect the outcome. We move it to /tmp
# so that it outside of the GITHUB_WORKSPACE.
- name: Move checkout to tmp
run: |
mv "${GITHUB_WORKSPACE}/todo-issue-reopener" "/tmp"
- id: create-issue
name: Create closed issue
env:
GH_TOKEN: ${{ github.token }}
PR_URL: ${{ github.event.pull_request.html_url }}
run: |
body=""
if [ "${PR_URL}" != "" ]; then
body="Test issue for commit $PR ${PR_URL}"
else
body="Test issue for commit ${GITHUB_SHA}"
fi
body="${body}
- [Workflow run](https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}/attempts/${GITHUB_RUN_ATTEMPT})"
url=$(gh issue create -R "${GITHUB_REPOSITORY}" --title "issue-reopener-vanityURLs pre-submit test issue" --body "${body}" --label "test-issue")
echo "::debug::Closing GitHub issue: ${url}"
gh issue close "${url}"
echo "url=${url}" >> "${GITHUB_OUTPUT}"
- name: Setup mock repo
env:
ISSUE_URL: ${{ steps.create-issue.outputs.url }}
run: |
git init
mkdir test
issue_no="${ISSUE_URL##*/}"
vanity_url="https://golang.org/issues/${issue_no}"
echo "::debug::Vanity issue url: ${url}"
echo "// TODO(${vanity_url}): still open" > test/test.go
mkdir .github
echo "vanityURLs:" >> .github/issue-reopener.yml
echo "- \"^\\\\s*(https?://)?golang.org/issues/(?<id>[0-9]+)\\\\s*$\"" >> .github/issue-reopener.yml
# NOTE: We cannot use dynamic variables or absolute paths.
# Here we must provide a path relative to GITHUB_WORKSPACE so we ensure
# we get back to the root tmp directory no matter what GITHUB_WORKSPACE
# directory is set to.
- name: Run todo-issue-reopener
uses: "./../../../../../../../../../../../tmp/todo-issue-reopener"
- env:
GH_TOKEN: ${{ github.token }}
ISSUE_URL: ${{ steps.create-issue.outputs.url }}
run: |
# Ensure the issue was reopened.
state=$(gh issue view "${ISSUE_URL}" --json state | jq -r '.state')
[ "${state}" == "OPEN" ]
# Check that the body contains the right path
# NOTE: Need to get text output in order to get issue comments.
body=$(gh issue view "${ISSUE_URL}" -c)
[[ "${body}" == *"1. [test/test.go:1]"* ]]
issue-reopener-vanityURLs-cleanup:
runs-on: ubuntu-latest
needs: issue-reopener-vanityURLs
if: ${{ always() }}
permissions:
issues: write
steps:
- env:
ISSUE_URL: ${{ needs.issue-reopener-vanityURLs.outputs.issue-url }}
GH_TOKEN: ${{ github.token }}
run: |
# Close the test issue.
gh issue close "${ISSUE_URL}" || true