Skip to content

Commit c4de811

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 fdf866f commit c4de811

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

actions/lint/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItY2hlY2stY2lyY2xlIiBjb2xvcj0iYmx1ZSI+PHBhdGggZD0iTTIyIDExLjA4VjEyYTEwIDEwIDAgMSAxLTUuOTMtOS4xNCI+PC9wYXRoPjxwb2x5bGluZSBwb2ludHM9IjIyIDQgMTIgMTQuMDEgOSAxMS4wMSI+PC9wb2x5bGluZT48L3N2Zz4=) GitHub Action: Lint
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/37509d7404c261847696d98c678948e95b072f3217fcfba735757b21fad5b5d7/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Lint" />
6+
<img src="https://opengraph.githubassets.com/9583af06e0716e1d6cf0f13319f864b9b10858c23c40a2073ed4ee97dc6dee98/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Lint" />
77
</div>
88

99
---
@@ -46,6 +46,10 @@ Action to lint Node.js projects with support for pull request reporting and anno
4646
# This should be a script defined in your `package.json`.
4747
# The command should generate lint report files in a standard format.
4848
#
49+
# ESLint: `eslint --format json -o eslint-report.json .`
50+
# Prettier: `prettier --check . | tee prettier-report.txt`
51+
# Astro: `astro check | tee astro-report.txt`
52+
#
4953
# Default: `lint:ci`
5054
command: lint:ci
5155

@@ -72,6 +76,10 @@ Action to lint Node.js projects with support for pull request reporting and anno
7276
| **`command`** | npm/pnpm/Yarn script command to run for linting. | **false** | `lint:ci` |
7377
| | This should be a script defined in your `package.json`. | | |
7478
| | The command should generate lint report files in a standard format. | | |
79+
| | | | |
80+
| | ESLint: `eslint --format json -o eslint-report.json .` | | |
81+
| | Prettier: `prettier --check . \| tee prettier-report.txt` | | |
82+
| | Astro: `astro check \| tee astro-report.txt` | | |
7583
| **`report-file`** | Optional lint report path forwarded to the [parse-ci-reports](https://hoverkraft-tech/ci-github-common/actions/parse-ci-reports) action. | **false** | - |
7684
| | Provide an absolute path or one relative to the working directory. | | |
7785
| | When omitted, the action falls back to `auto:lint` detection. | | |

actions/test/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItY2hlY2stc3F1YXJlIiBjb2xvcj0iYmx1ZSI+PHBvbHlsaW5lIHBvaW50cz0iOSAxMSAxMiAxNCAyMiA0Ij48L3BvbHlsaW5lPjxwYXRoIGQ9Ik0yMSAxMnY3YTIgMiAwIDAgMS0yIDJINWEyIDIgMCAwIDEtMi0yVjVhMiAyIDAgMCAxIDItMmgxMSI+PC9wYXRoPjwvc3ZnPg==) GitHub Action: Test
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/37509d7404c261847696d98c678948e95b072f3217fcfba735757b21fad5b5d7/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Test" />
6+
<img src="https://opengraph.githubassets.com/9583af06e0716e1d6cf0f13319f864b9b10858c23c40a2073ed4ee97dc6dee98/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Test" />
77
</div>
88

99
---
@@ -46,6 +46,9 @@ Action to test Node.js projects with support for coverage reporting and pull req
4646
# This should be a script defined in your `package.json`.
4747
# The command should generate coverage report files in a standard format (Cobertura XML, lcov, etc.).
4848
#
49+
# Vitest: `vitest run --reporter=default --reporter=junit --outputFile=junit.xml --coverage.enabled --coverage.reporter=lcov --coverage.reporter=text`
50+
# Jest: `jest --ci --reporters=default --reporters=jest-junit --coverage`
51+
#
4952
# Default: `test:ci`
5053
command: test:ci
5154

@@ -86,6 +89,9 @@ Action to test Node.js projects with support for coverage reporting and pull req
8689
| **`command`** | npm/pnpm/Yarn script command to run for testing. | **false** | `test:ci` |
8790
| | This should be a script defined in your `package.json`. | | |
8891
| | The command should generate coverage report files in a standard format (Cobertura XML, lcov, etc.). | | |
92+
| | | | |
93+
| | Vitest: `vitest run --reporter=default --reporter=junit --outputFile=junit.xml --coverage.enabled --coverage.reporter=lcov --coverage.reporter=text` | | |
94+
| | Jest: `jest --ci --reporters=default --reporters=jest-junit --coverage` | | |
8995
| **`coverage`** | Code coverage reporter to use. Supported values: | **false** | `github` |
9096
| | - `github`: Parse coverage reports via [parse-ci-reports](https://hoverkraft-tech/ci-github-common/actions/parse-ci-reports) action, with GitHub summaries/PR comments | | |
9197
| | - `codecov`: Upload coverage to Codecov | | |

0 commit comments

Comments
 (0)