diff --git a/.github/workflows/continuous-integration.md b/.github/workflows/continuous-integration.md index 7e087a5..910be3d 100644 --- a/.github/workflows/continuous-integration.md +++ b/.github/workflows/continuous-integration.md @@ -3,7 +3,7 @@ # GitHub Reusable Workflow: Node.js Continuous Integration
- Node.js Continuous Integration + Node.js Continuous Integration
--- @@ -53,7 +53,7 @@ on: permissions: {} jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@a9809af04394e66675b8644865be1ddcec02cdcd # 0.20.0 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1 permissions: {} secrets: # Secrets to be used during the build step. @@ -113,7 +113,7 @@ jobs: # Whether to enable linting. # Set to `null` or empty to disable. - # Accepts a JSON object for lint options. See [lint action](../actions/lint/README.md). + # Accepts a JSON object for lint options. See [lint action](../../actions/lint/README.md). # It should generate lint reports in standard formats. # # Example: @@ -142,7 +142,7 @@ jobs: # Whether to enable testing. # Set to `null` or empty to disable. - # Accepts a JSON object for test options. See [test action](../actions/test/README.md). + # Accepts a JSON object for test options. See [test action](../../actions/test/README.md). # If coverage is enabled, it should generate test and coverage reports in standard formats. # # Example: @@ -233,7 +233,7 @@ jobs: | **`checks`** | Optional flag to enable check steps. | **false** | **boolean** | `true` | | **`lint`** | Whether to enable linting. | **false** | **string** | `true` | | | Set to `null` or empty to disable. | | | | -| | Accepts a JSON object for lint options. See [lint action](../actions/lint/README.md). | | | | +| | Accepts a JSON object for lint options. See [lint action](../../actions/lint/README.md). | | | | | | It should generate lint reports in standard formats. | | | | | | | | | | | | Example: | | | | @@ -246,7 +246,7 @@ jobs: | | See . | | | | | **`test`** | Whether to enable testing. | **false** | **string** | `true` | | | Set to `null` or empty to disable. | | | | -| | Accepts a JSON object for test options. See [test action](../actions/test/README.md). | | | | +| | Accepts a JSON object for test options. See [test action](../../actions/test/README.md). | | | | | | If coverage is enabled, it should generate test and coverage reports in standard formats. | | | | | | | | | | | | Example: | | | | @@ -387,7 +387,7 @@ on: jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@a9809af04394e66675b8644865be1ddcec02cdcd # 0.20.0 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1 permissions: id-token: write security-events: write @@ -453,7 +453,7 @@ jobs: # Run CI checks inside the Docker container continuous-integration: needs: build-image - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@a9809af04394e66675b8644865be1ddcec02cdcd # 0.20.0 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1 permissions: id-token: write security-events: write @@ -477,7 +477,7 @@ on: branches: [main] jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@a9809af04394e66675b8644865be1ddcec02cdcd # 0.20.0 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1 permissions: id-token: write security-events: write @@ -505,7 +505,7 @@ on: jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@a9809af04394e66675b8644865be1ddcec02cdcd # 0.20.0 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1 permissions: id-token: write security-events: write diff --git a/actions/build/README.md b/actions/build/README.md index f6dfd24..1d91a6c 100644 --- a/actions/build/README.md +++ b/actions/build/README.md @@ -3,7 +3,7 @@ # ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItcGFja2FnZSIgY29sb3I9ImJsdWUiPjxsaW5lIHgxPSIxNi41IiB5MT0iOS40IiB4Mj0iNy41IiB5Mj0iNC4yMSI+PC9saW5lPjxwYXRoIGQ9Ik0yMSAxNlY4YTIgMiAwIDAgMC0xLTEuNzNsLTctNGEyIDIgMCAwIDAtMiAwbC03IDRBMiAyIDAgMCAwIDMgOHY4YTIgMiAwIDAgMCAxIDEuNzNsNyA0YTIgMiAwIDAgMCAyIDBsNy00QTIgMiAwIDAgMCAyMSAxNnoiPjwvcGF0aD48cG9seWxpbmUgcG9pbnRzPSIzLjI3IDYuOTYgMTIgMTIuMDEgMjAuNzMgNi45NiI+PC9wb2x5bGluZT48bGluZSB4MT0iMTIiIHkxPSIyMi4wOCIgeDI9IjEyIiB5Mj0iMTIiPjwvbGluZT48L3N2Zz4=) GitHub Action: Build
- Build + Build
--- @@ -30,7 +30,7 @@ Action to build Node.js projects with support for custom commands, environment v ## Usage ````yaml -- uses: hoverkraft-tech/ci-github-nodejs/actions/build@a9809af04394e66675b8644865be1ddcec02cdcd # 0.20.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/build@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1 with: # Working directory where the build commands are executed. # Can be absolute or relative to the repository root. @@ -39,27 +39,41 @@ Action to build Node.js projects with support for custom commands, environment v working-directory: . # List of build commands to execute, one per line. - # These are npm/pnpm/Yarn script names (e.g., "build", "compile"). + # These are npm/pnpm/Yarn script names (e.g., `build`, `compile`). # # This input is required. build-commands: "" # JSON object of environment variables to set during the build. - # Example: {"NODE_ENV": "production", "API_URL": "https://api.example.com"} + # Example: + # + # ```json + # { + # "NODE_ENV": "production", + # "API_URL": "https://api.example.com" + # } + # ``` # # Default: `{}` build-env: "{}" - # Multi-line string of secrets in env format (KEY=VALUE). + # Multi-line string of secrets in env format (`KEY=VALUE`). # Example: - # ``` + # ```txt # SECRET_KEY=$\{{ secrets.SECRET_KEY }} # API_TOKEN=$\{{ secrets.API_TOKEN }} # ``` build-secrets: "" # JSON object specifying artifact upload configuration. - # Format: {"name": "artifact-name", "paths": "path1\npath2"} + # Example: + # + # ```json + # { + # "name": "artifact-name", + # "paths": "path1\npath2" + # } + # ``` build-artifact: "" # Whether running in container mode (skips checkout and node setup) @@ -72,20 +86,24 @@ Action to build Node.js projects with support for custom commands, environment v ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | -| **`working-directory`** | Working directory where the build commands are executed. | **false** | `.` | -| | Can be absolute or relative to the repository root. | | | -| **`build-commands`** | List of build commands to execute, one per line. | **true** | - | -| | These are npm/pnpm/Yarn script names (e.g., "build", "compile"). | | | -| **`build-env`** | JSON object of environment variables to set during the build. | **false** | `\{}` | -| | Example: {"NODE_ENV": "production", "API_URL": " | | | -| **`build-secrets`** | Multi-line string of secrets in env format (KEY=VALUE). | **false** | - | -| | Example: | | | -| | 
SECRET_KEY=$\{{ secrets.SECRET_KEY }}
API_TOKEN=$\{{ secrets.API_TOKEN }}
| | | -| **`build-artifact`** | JSON object specifying artifact upload configuration. | **false** | - | -| | Format: {"name": "artifact-name", "paths": "path1\npath2"} | | | -| **`container`** | Whether running in container mode (skips checkout and node setup) | **false** | `false` | +| **Input** | **Description** | **Required** | **Default** | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | +| **`working-directory`** | Working directory where the build commands are executed. | **false** | `.` | +| | Can be absolute or relative to the repository root. | | | +| **`build-commands`** | List of build commands to execute, one per line. | **true** | - | +| | These are npm/pnpm/Yarn script names (e.g., `build`, `compile`). | | | +| **`build-env`** | JSON object of environment variables to set during the build. | **false** | `\{}` | +| | Example: | | | +| | | | | +| | 
{
 "NODE_ENV": "production",
 "API_URL": "https://api.example.com"
}
| | | +| **`build-secrets`** | Multi-line string of secrets in env format (`KEY=VALUE`). | **false** | - | +| | Example: | | | +| | 
SECRET_KEY=$\{{ secrets.SECRET_KEY }}
API_TOKEN=$\{{ secrets.API_TOKEN }}
| | | +| **`build-artifact`** | JSON object specifying artifact upload configuration. | **false** | - | +| | Example: | | | +| | | | | +| | 
{
 "name": "artifact-name",
 "paths": "path1\npath2"
}
| | | +| **`container`** | Whether running in container mode (skips checkout and node setup) | **false** | `false` | diff --git a/actions/dependencies-cache/README.md b/actions/dependencies-cache/README.md index 70ae5ee..d63a720 100644 --- a/actions/dependencies-cache/README.md +++ b/actions/dependencies-cache/README.md @@ -3,7 +3,7 @@ # ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItYXJjaGl2ZSIgY29sb3I9ImJsdWUiPjxwb2x5bGluZSBwb2ludHM9IjIxIDggMjEgMjEgMyAyMSAzIDgiPjwvcG9seWxpbmU+PHJlY3QgeD0iMSIgeT0iMyIgd2lkdGg9IjIyIiBoZWlnaHQ9IjUiPjwvcmVjdD48bGluZSB4MT0iMTAiIHkxPSIxMiIgeDI9IjE0IiB5Mj0iMTIiPjwvbGluZT48L3N2Zz4=) GitHub Action: Dependencies cache
- Dependencies cache + Dependencies cache
--- @@ -33,7 +33,7 @@ Action to setup dependencies cache managment. ## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs/actions/dependencies-cache@a9809af04394e66675b8644865be1ddcec02cdcd # 0.20.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/dependencies-cache@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1 with: # List of dependencies for which the cache should be managed. # This input is required. diff --git a/actions/get-package-manager/README.md b/actions/get-package-manager/README.md index 86b1ccb..69efc87 100644 --- a/actions/get-package-manager/README.md +++ b/actions/get-package-manager/README.md @@ -3,7 +3,7 @@ # ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItcGFja2FnZSIgY29sb3I9ImJsdWUiPjxsaW5lIHgxPSIxNi41IiB5MT0iOS40IiB4Mj0iNy41IiB5Mj0iNC4yMSI+PC9saW5lPjxwYXRoIGQ9Ik0yMSAxNlY4YTIgMiAwIDAgMC0xLTEuNzNsLTctNGEyIDIgMCAwIDAtMiAwbC03IDRBMiAyIDAgMCAwIDMgOHY4YTIgMiAwIDAgMCAxIDEuNzNsNyA0YTIgMiAwIDAgMCAyIDBsNy00QTIgMiAwIDAgMCAyMSAxNnoiPjwvcGF0aD48cG9seWxpbmUgcG9pbnRzPSIzLjI3IDYuOTYgMTIgMTIuMDEgMjAuNzMgNi45NiI+PC9wb2x5bGluZT48bGluZSB4MT0iMTIiIHkxPSIyMi4wOCIgeDI9IjEyIiB5Mj0iMTIiPjwvbGluZT48L3N2Zz4=) GitHub Action: Get package manager
- Get package manager + Get package manager
--- @@ -33,7 +33,7 @@ Action to detect the package manager used. Supports Yarn, pnpm, and npm ## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs/actions/get-package-manager@a9809af04394e66675b8644865be1ddcec02cdcd # 0.20.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/get-package-manager@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1 with: # Working directory where the dependencies are installed. # Can be absolute or relative to the repository root. diff --git a/actions/has-installed-dependencies/README.md b/actions/has-installed-dependencies/README.md index 6806e51..72457cf 100644 --- a/actions/has-installed-dependencies/README.md +++ b/actions/has-installed-dependencies/README.md @@ -3,7 +3,7 @@ # ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItc2V0dGluZ3MiIGNvbG9yPSJibHVlIj48Y2lyY2xlIGN4PSIxMiIgY3k9IjEyIiByPSIzIj48L2NpcmNsZT48cGF0aCBkPSJNMTkuNCAxNWExLjY1IDEuNjUgMCAwIDAgLjMzIDEuODJsLjA2LjA2YTIgMiAwIDAgMSAwIDIuODMgMiAyIDAgMCAxLTIuODMgMGwtLjA2LS4wNmExLjY1IDEuNjUgMCAwIDAtMS44Mi0uMzMgMS42NSAxLjY1IDAgMCAwLTEgMS41MVYyMWEyIDIgMCAwIDEtMiAyIDIgMiAwIDAgMS0yLTJ2LS4wOUExLjY1IDEuNjUgMCAwIDAgOSAxOS40YTEuNjUgMS42NSAwIDAgMC0xLjgyLjMzbC0uMDYuMDZhMiAyIDAgMCAxLTIuODMgMCAyIDIgMCAwIDEgMC0yLjgzbC4wNi0uMDZhMS42NSAxLjY1IDAgMCAwIC4zMy0xLjgyIDEuNjUgMS42NSAwIDAgMC0xLjUxLTFIM2EyIDIgMCAwIDEtMi0yIDIgMiAwIDAgMSAyLTJoLjA5QTEuNjUgMS42NSAwIDAgMCA0LjYgOWExLjY1IDEuNjUgMCAwIDAtLjMzLTEuODJsLS4wNi0uMDZhMiAyIDAgMCAxIDAtMi44MyAyIDIgMCAwIDEgMi44MyAwbC4wNi4wNmExLjY1IDEuNjUgMCAwIDAgMS44Mi4zM0g5YTEuNjUgMS42NSAwIDAgMCAxLTEuNTFWM2EyIDIgMCAwIDEgMi0yIDIgMiAwIDAgMSAyIDJ2LjA5YTEuNjUgMS42NSAwIDAgMCAxIDEuNTEgMS42NSAxLjY1IDAgMCAwIDEuODItLjMzbC4wNi0uMDZhMiAyIDAgMCAxIDIuODMgMCAyIDIgMCAwIDEgMCAyLjgzbC0uMDYuMDZhMS42NSAxLjY1IDAgMCAwLS4zMyAxLjgyVjlhMS42NSAxLjY1IDAgMCAwIDEuNTEgMUgyMWEyIDIgMCAwIDEgMiAyIDIgMiAwIDAgMS0yIDJoLS4wOWExLjY1IDEuNjUgMCAwIDAtMS41MSAxeiI+PC9wYXRoPjwvc3ZnPg==) GitHub Action: Has installed dependencies
- Has installed dependencies + Has installed dependencies
--- @@ -33,7 +33,7 @@ Action to check if dependencies have been installed according to the package man ## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs/actions/has-installed-dependencies@a9809af04394e66675b8644865be1ddcec02cdcd # 0.20.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/has-installed-dependencies@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1 with: # The dependencies to check. # This input is required. diff --git a/actions/lint/README.md b/actions/lint/README.md index 734cf80..83723d4 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
--- @@ -30,7 +30,7 @@ Action to lint Node.js projects with support for pull request reporting and anno ## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs/actions/lint@a9809af04394e66675b8644865be1ddcec02cdcd # 0.20.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/lint@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1 with: # Working directory where lint commands are executed. # Can be absolute or relative to the repository root. @@ -42,8 +42,8 @@ Action to lint Node.js projects with support for pull request reporting and anno # Default: `false` container: "false" - # NPM/package manager script command to run for linting. - # This should be a script defined in your package.json. + # npm/pnpm/Yarn script command to run for linting. + # This should be a script defined in your `package.json`. # The command should generate lint report files in a standard format. # # Default: `lint:ci` @@ -51,7 +51,7 @@ Action to lint Node.js projects with support for pull request reporting and anno # Optional lint report path forwarded to the [parse-ci-reports](https://hoverkraft-tech/ci-github-common/actions/parse-ci-reports) action. # Provide an absolute path or one relative to the working directory. - # When omitted, the action falls back to "auto:lint" detection. + # When omitted, the action falls back to `auto:lint` detection. report-file: "" # Optional path mapping to adjust file paths in test and coverage reports. @@ -69,12 +69,12 @@ Action to lint Node.js projects with support for pull request reporting and anno | **`working-directory`** | Working directory where lint commands are executed. | **false** | `.` | | | Can be absolute or relative to the repository root. | | | | **`container`** | Whether running in container mode (skips checkout and node setup) | **false** | `false` | -| **`command`** | NPM/package manager script command to run for linting. | **false** | `lint:ci` | -| | This should be a script defined in your package.json. | | | +| **`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. | | | | **`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. | | | +| | When omitted, the action falls back to `auto:lint` detection. | | | | **`path-mapping`** | Optional path mapping to adjust file paths in test and coverage reports. | **false** | - | | | See the [parse-ci-reports documentation](https://hoverkraft-tech/ci-github-common/actions/parse-ci-reports) for details. | | | diff --git a/actions/setup-node/README.md b/actions/setup-node/README.md index 92d564d..27bab1f 100644 --- a/actions/setup-node/README.md +++ b/actions/setup-node/README.md @@ -3,7 +3,7 @@ # ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItc2V0dGluZ3MiIGNvbG9yPSJibHVlIj48Y2lyY2xlIGN4PSIxMiIgY3k9IjEyIiByPSIzIj48L2NpcmNsZT48cGF0aCBkPSJNMTkuNCAxNWExLjY1IDEuNjUgMCAwIDAgLjMzIDEuODJsLjA2LjA2YTIgMiAwIDAgMSAwIDIuODMgMiAyIDAgMCAxLTIuODMgMGwtLjA2LS4wNmExLjY1IDEuNjUgMCAwIDAtMS44Mi0uMzMgMS42NSAxLjY1IDAgMCAwLTEgMS41MVYyMWEyIDIgMCAwIDEtMiAyIDIgMiAwIDAgMS0yLTJ2LS4wOUExLjY1IDEuNjUgMCAwIDAgOSAxOS40YTEuNjUgMS42NSAwIDAgMC0xLjgyLjMzbC0uMDYuMDZhMiAyIDAgMCAxLTIuODMgMCAyIDIgMCAwIDEgMC0yLjgzbC4wNi0uMDZhMS42NSAxLjY1IDAgMCAwIC4zMy0xLjgyIDEuNjUgMS42NSAwIDAgMC0xLjUxLTFIM2EyIDIgMCAwIDEtMi0yIDIgMiAwIDAgMSAyLTJoLjA5QTEuNjUgMS42NSAwIDAgMCA0LjYgOWExLjY1IDEuNjUgMCAwIDAtLjMzLTEuODJsLS4wNi0uMDZhMiAyIDAgMCAxIDAtMi44MyAyIDIgMCAwIDEgMi44MyAwbC4wNi4wNmExLjY1IDEuNjUgMCAwIDAgMS44Mi4zM0g5YTEuNjUgMS42NSAwIDAgMCAxLTEuNTFWM2EyIDIgMCAwIDEgMi0yIDIgMiAwIDAgMSAyIDJ2LjA5YTEuNjUgMS42NSAwIDAgMCAxIDEuNTEgMS42NSAxLjY1IDAgMCAwIDEuODItLjMzbC4wNi0uMDZhMiAyIDAgMCAxIDIuODMgMCAyIDIgMCAwIDEgMCAyLjgzbC0uMDYuMDZhMS42NSAxLjY1IDAgMCAwLS4zMyAxLjgyVjlhMS42NSAxLjY1IDAgMCAwIDEuNTEgMUgyMWEyIDIgMCAwIDEgMiAyIDIgMiAwIDAgMS0yIDJoLS4wOWExLjY1IDEuNjUgMCAwIDAtMS41MSAxeiI+PC9wYXRoPjwvc3ZnPg==) GitHub Action: Setup Node.js
- Setup Node.js + Setup Node.js
--- @@ -33,7 +33,7 @@ Action to setup Node.js and install dependencies according to the package manage ## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@a9809af04394e66675b8644865be1ddcec02cdcd # 0.20.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1 with: # List of dependencies for which the cache should be managed dependencies-cache: "" diff --git a/actions/test/README.md b/actions/test/README.md index c034951..12d7b83 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
--- @@ -30,7 +30,7 @@ Action to test Node.js projects with support for coverage reporting and pull req ## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs/actions/test@a9809af04394e66675b8644865be1ddcec02cdcd # 0.20.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/test@80acfc9bc4dd87030d73006dee4c788ed9af1fb0 # 0.20.1 with: # Working directory where test commands are executed. # Can be absolute or relative to the repository root. @@ -42,8 +42,8 @@ Action to test Node.js projects with support for coverage reporting and pull req # Default: `false` container: "false" - # NPM/package manager script command to run for testing. - # This should be a script defined in your package.json. + # npm/pnpm/Yarn script command to run for testing. + # 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.). # # Default: `test:ci` @@ -57,11 +57,11 @@ Action to test Node.js projects with support for coverage reporting and pull req # Default: `github` coverage: github - # Optional test and coverage report paths forwarded to the hoverkraft-tech/ci-github-common/actions/parse-ci-reports action. + # Optional test and coverage report paths forwarded to the [parse-ci-reports](https://hoverkraft-tech/ci-github-common/actions/parse-ci-reports) action. # Supports multiple formats (Cobertura, OpenCover, lcov, etc.). # Provide absolute paths or paths relative to the working directory. # Multiple entries can be separated by newlines, commas, or semicolons. - # When omitted, the action falls back to "auto:test,auto:coverage" detection. + # When omitted, the action falls back to `auto:test,auto:coverage` detection. report-file: "" # Optional path mapping to adjust file paths in test and coverage reports. @@ -83,18 +83,18 @@ Action to test Node.js projects with support for coverage reporting and pull req | **`working-directory`** | Working directory where test commands are executed. | **false** | `.` | | | Can be absolute or relative to the repository root. | | | | **`container`** | Whether running in container mode (skips checkout and node setup) | **false** | `false` | -| **`command`** | NPM/package manager script command to run for testing. | **false** | `test:ci` | -| | This should be a script defined in your package.json. | | | +| **`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.). | | | | **`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 | | | | | - `""` or `null`: No coverage reporting | | | -| **`report-file`** | Optional test and coverage report paths forwarded to the hoverkraft-tech/ci-github-common/actions/parse-ci-reports action. | **false** | - | +| **`report-file`** | Optional test and coverage report paths forwarded to the [parse-ci-reports](https://hoverkraft-tech/ci-github-common/actions/parse-ci-reports) action. | **false** | - | | | Supports multiple formats (Cobertura, OpenCover, lcov, etc.). | | | | | Provide absolute paths or paths relative to the working directory. | | | | | Multiple entries can be separated by newlines, commas, or semicolons. | | | -| | When omitted, the action falls back to "auto:test,auto:coverage" detection. | | | +| | When omitted, the action falls back to `auto:test,auto:coverage` detection. | | | | **`path-mapping`** | Optional path mapping to adjust file paths in test and coverage reports. | **false** | - | | | See the [parse-ci-reports documentation](https://hoverkraft-tech/ci-github-common/actions/parse-ci-reports) for details. | | | | **`github-token`** | GitHub token for coverage PR comments. | **false** | - |