Skip to content

docs: update actions and workflows documentation #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hoverkraft-bot merged 1 commit into from
Nov 24, 2025
Merged

docs: update actions and workflows documentation #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion actions/lint/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItY2hlY2stY2lyY2xlIiBjb2xvcj0iYmx1ZSI+PHBhdGggZD0iTTIyIDExLjA4VjEyYTEwIDEwIDAgMSAxLTUuOTMtOS4xNCI+PC9wYXRoPjxwb2x5bGluZSBwb2ludHM9IjIyIDQgMTIgMTQuMDEgOSAxMS4wMSI+PC9wb2x5bGluZT48L3N2Zz4=) GitHub Action: Lint

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

---
Expand Down Expand Up @@ -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

Expand All @@ -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. | | |
Expand Down
8 changes: 7 additions & 1 deletion actions/test/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItY2hlY2stc3F1YXJlIiBjb2xvcj0iYmx1ZSI+PHBvbHlsaW5lIHBvaW50cz0iOSAxMSAxMiAxNCAyMiA0Ij48L3BvbHlsaW5lPjxwYXRoIGQ9Ik0yMSAxMnY3YTIgMiAwIDAgMS0yIDJINWEyIDIgMCAwIDEtMi0yVjVhMiAyIDAgMCAxIDItMmgxMSI+PC9wYXRoPjwvc3ZnPg==) GitHub Action: Test

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

---
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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 | | |
Expand Down