diff --git a/actions/lint/README.md b/actions/lint/README.md index c3022ee..3d70567 100644 --- a/actions/lint/README.md +++ b/actions/lint/README.md @@ -3,7 +3,7 @@ # ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItY2hlY2stY2lyY2xlIiBjb2xvcj0iYmx1ZSI+PHBhdGggZD0iTTIyIDExLjA4VjEyYTEwIDEwIDAgMSAxLTUuOTMtOS4xNCI+PC9wYXRoPjxwb2x5bGluZSBwb2ludHM9IjIyIDQgMTIgMTQuMDEgOSAxMS4wMSI+PC9wb2x5bGluZT48L3N2Zz4=) GitHub Action: Lint
- Lint + Lint
--- @@ -46,6 +46,10 @@ Action to lint Node.js projects with support for pull request reporting and anno # This should be a script defined in your `package.json`. # The command should generate lint report files in a standard format. # + # ESLint: `eslint --format json -o eslint-report.json .` + # Prettier: `prettier --check . | tee prettier-report.txt` + # Astro: `astro check | tee astro-report.txt` + # # Default: `lint:ci` command: lint:ci @@ -72,6 +76,10 @@ Action to lint Node.js projects with support for pull request reporting and anno | **`command`** | npm/pnpm/Yarn script command to run for linting. | **false** | `lint:ci` | | | This should be a script defined in your `package.json`. | | | | | The command should generate lint report files in a standard format. | | | +| | | | | +| | ESLint: `eslint --format json -o eslint-report.json .` | | | +| | Prettier: `prettier --check . \| tee prettier-report.txt` | | | +| | Astro: `astro check \| tee astro-report.txt` | | | | **`report-file`** | Optional lint report path forwarded to the [parse-ci-reports](https://hoverkraft-tech/ci-github-common/actions/parse-ci-reports) action. | **false** | - | | | Provide an absolute path or one relative to the working directory. | | | | | When omitted, the action falls back to `auto:lint` detection. | | | diff --git a/actions/test/README.md b/actions/test/README.md index c984f3b..f6dae4a 100644 --- a/actions/test/README.md +++ b/actions/test/README.md @@ -3,7 +3,7 @@ # ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItY2hlY2stc3F1YXJlIiBjb2xvcj0iYmx1ZSI+PHBvbHlsaW5lIHBvaW50cz0iOSAxMSAxMiAxNCAyMiA0Ij48L3BvbHlsaW5lPjxwYXRoIGQ9Ik0yMSAxMnY3YTIgMiAwIDAgMS0yIDJINWEyIDIgMCAwIDEtMi0yVjVhMiAyIDAgMCAxIDItMmgxMSI+PC9wYXRoPjwvc3ZnPg==) GitHub Action: Test
- Test + Test
--- @@ -46,6 +46,9 @@ Action to test Node.js projects with support for coverage reporting and pull req # This should be a script defined in your `package.json`. # The command should generate coverage report files in a standard format (Cobertura XML, lcov, etc.). # + # Vitest: `vitest run --reporter=default --reporter=junit --outputFile=junit.xml --coverage.enabled --coverage.reporter=lcov --coverage.reporter=text` + # Jest: `jest --ci --reporters=default --reporters=jest-junit --coverage` + # # Default: `test:ci` command: test:ci @@ -86,6 +89,9 @@ Action to test Node.js projects with support for coverage reporting and pull req | **`command`** | npm/pnpm/Yarn script command to run for testing. | **false** | `test:ci` | | | This should be a script defined in your `package.json`. | | | | | The command should generate coverage report files in a standard format (Cobertura XML, lcov, etc.). | | | +| | | | | +| | Vitest: `vitest run --reporter=default --reporter=junit --outputFile=junit.xml --coverage.enabled --coverage.reporter=lcov --coverage.reporter=text` | | | +| | Jest: `jest --ci --reporters=default --reporters=jest-junit --coverage` | | | | **`coverage`** | Code coverage reporter to use. Supported values: | **false** | `github` | | | - `github`: Parse coverage reports via [parse-ci-reports](https://hoverkraft-tech/ci-github-common/actions/parse-ci-reports) action, with GitHub summaries/PR comments | | | | | - `codecov`: Upload coverage to Codecov | | |