Skip to content

Commit 435a3d6

Browse files
docs: update actions and workflows documentation
[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 37ad7f1 commit 435a3d6

4 files changed

Lines changed: 22 additions & 22 deletions

File tree

.github/workflows/linter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ on:
6464
permissions: {}
6565
jobs:
6666
linter:
67-
uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
67+
uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
6868
permissions: {}
6969
secrets:
7070
# Token for marking the status of linter run in the Checks section.

actions/get-matrix-outputs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Workaround for <https://github.com/orgs/community/discussions/26639>.
3434
## Usage
3535

3636
```yaml
37-
- uses: hoverkraft-tech/ci-github-common/actions/get-matrix-outputs@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
37+
- uses: hoverkraft-tech/ci-github-common/actions/get-matrix-outputs@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
3838
with:
3939
# The name of the artifact to download.
4040
# This input is required.

actions/parse-ci-reports/README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ It supports multiple common report standards out of the box.
5757
## Usage
5858

5959
```yaml
60-
- uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
60+
- uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
6161
with:
6262
# Paths to report files (glob patterns supported, one per line or comma-separated).
6363
# Set to `auto:test`, `auto:coverage`, `auto:lint`, or `auto:all` for automatic detection.
@@ -155,7 +155,7 @@ Let the action automatically find common report files:
155155

156156
```yaml
157157
- name: Parse all CI reports
158-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
158+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
159159
with:
160160
report-paths: "auto:all"
161161
report-name: "CI Results"
@@ -165,7 +165,7 @@ Or target specific report types:
165165

166166
```yaml
167167
- name: Parse test reports only
168-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
168+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
169169
with:
170170
report-paths: "auto:test"
171171
report-name: "Test Results"
@@ -186,7 +186,7 @@ Auto-detection modes:
186186
```yaml
187187
- name: Parse test reports
188188
id: parse-reports
189-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
189+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
190190
with:
191191
report-paths: "**/test-results/*.xml"
192192
report-name: "Test Results"
@@ -203,7 +203,7 @@ Auto-detection modes:
203203

204204
```yaml
205205
- name: Parse coverage
206-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
206+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
207207
with:
208208
report-paths: "coverage/cobertura-coverage.xml"
209209
report-name: "Coverage Report"
@@ -222,7 +222,7 @@ formatting issues alongside other lint results:
222222
npx prettier --check "src/**/*.{js,ts,tsx}" | tee prettier-check.log
223223
224224
- name: Parse Prettier report
225-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
225+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
226226
with:
227227
report-paths: "prettier-check.log"
228228
report-name: "Prettier Formatting"
@@ -245,7 +245,7 @@ linting tools:
245245
npx astro check --minimumFailingSeverity warning | tee astro-check.log
246246
247247
- name: Parse astro diagnostics
248-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
248+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
249249
with:
250250
report-paths: "astro-check.log"
251251
report-name: "Astro Diagnostics"
@@ -256,7 +256,7 @@ linting tools:
256256

257257
```yaml
258258
- name: Parse test reports
259-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
259+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
260260
with:
261261
report-paths: "**/junit.xml"
262262
report-name: "Test Results"
@@ -269,7 +269,7 @@ Generate GitHub annotations for failed tests and linting issues:
269269

270270
```yaml
271271
- name: Parse reports with annotations
272-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
272+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
273273
with:
274274
report-paths: "auto:all"
275275
report-name: "CI Results"
@@ -282,7 +282,7 @@ Combine multiple output formats using comma-separated values:
282282

283283
```yaml
284284
- name: Parse reports with multiple outputs
285-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
285+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
286286
with:
287287
report-paths: "auto:all"
288288
report-name: "CI Results"
@@ -293,7 +293,7 @@ Or use "all" for all output formats:
293293

294294
```yaml
295295
- name: Parse reports with all outputs
296-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
296+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
297297
with:
298298
report-paths: "auto:test"
299299
report-name: "Test Results"
@@ -312,7 +312,7 @@ Parse test results, coverage, and linting in one action:
312312
run: npm run lint -- --format json --output-file eslint-report.json
313313
314314
- name: Parse all reports
315-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
315+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
316316
with:
317317
report-paths: |
318318
test-results/junit.xml
@@ -327,7 +327,7 @@ When working in a monorepo or nested package, set `working-directory` so glob pa
327327

328328
```yaml
329329
- name: Parse frontend reports
330-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
330+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
331331
with:
332332
working-directory: packages/frontend
333333
report-paths: |
@@ -346,7 +346,7 @@ When running tests in a container or different directory, use path-mapping to en
346346
docker run --rm -v ${{ github.workspace }}:/app myimage npm test
347347
348348
- name: Parse test reports
349-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
349+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
350350
with:
351351
report-paths: "test-results/junit.xml"
352352
report-name: "Test Results"
@@ -362,7 +362,7 @@ When you have multiple source directories that need rewriting, provide multiple
362362

363363
```yaml
364364
- name: Parse reports with multiple path mappings
365-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
365+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
366366
with:
367367
report-paths: "auto:all"
368368
report-name: "CI Results"
@@ -377,7 +377,7 @@ Or using comma-separated format:
377377

378378
```yaml
379379
- name: Parse reports with multiple path mappings
380-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
380+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
381381
with:
382382
report-paths: "auto:all"
383383
report-name: "CI Results"
@@ -391,7 +391,7 @@ Another example for complex Docker overlay paths:
391391

392392
```yaml
393393
- name: Parse reports with path rewriting
394-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
394+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
395395
with:
396396
report-paths: "auto:all"
397397
report-name: "CI Results"
@@ -405,7 +405,7 @@ Only comment on PRs if there are failures:
405405
```yaml
406406
- name: Parse test reports
407407
id: parse-reports
408-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
408+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
409409
with:
410410
report-paths: "**/test-results/*.xml"
411411
report-name: "Test Results"
@@ -431,7 +431,7 @@ Only comment on PRs if there are failures:
431431
run: mvn test
432432
433433
- name: Parse all test reports
434-
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
434+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
435435
with:
436436
report-paths: |
437437
pytest-results.xml

actions/set-matrix-output/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This strategy effectively prevents any clashes or overwrites, maintaining the in
3838
## Usage
3939

4040
```yaml
41-
- uses: hoverkraft-tech/ci-github-common/actions/set-matrix-output@4bfbc05c189f1177cf7d47d3060cd1cbddf04ce2 # 0.32.0
41+
- uses: hoverkraft-tech/ci-github-common/actions/set-matrix-output@f5847cb398fe65d53794e6aba98ebdfa0801f691 # 0.32.0
4242
with:
4343
# The matrix output to set.
4444
# This input is required.

0 commit comments

Comments
 (0)