diff --git a/.github/workflows/continuous-integration.md b/.github/workflows/continuous-integration.md index bcef730..0fb99cd 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
--- @@ -52,7 +52,8 @@ on: permissions: {} jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@ce2bb8274a37c1219be2bcae2a1b2528c2c72957 # 0.19.0 + permissions: {} secrets: # Secrets to be used during the build step. # Must be a multi-line env formatted string. @@ -61,6 +62,11 @@ jobs: # SECRET_EXAMPLE=$\{{ secrets.SECRET_EXAMPLE }} # ``` build-secrets: "" + + # Password for container registry authentication, if required. + # Used when the container image is hosted in a private registry. + # See https://docs.github.com/en/actions/how-tos/write-workflows/choose-where-workflows-run/run-jobs-in-a-container#defining-credentials-for-a-container-registry. + container-password: "" with: # JSON array of runner(s) to use. # See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job. @@ -130,21 +136,28 @@ jobs: # Accepts either a string (container image name) or a JSON object with container options. # # String format (simple): + # ```yml # container: "node:18" + # ``` # # JSON object format (advanced): - # container: | - # { - # "image": "node:18", - # "env": { - # "NODE_ENV": "production" - # }, - # "ports": [8080], - # "volumes": ["/tmp:/tmp"], - # "options": "--cpus 2" - # } + # ```json + # { + # "image": "node:18", + # "env": { + # "NODE_ENV": "production" + # }, + # "options": "--cpus 2", + # "ports": [8080, 3000], + # "volumes": ["/tmp:/tmp", "/cache:/cache"], + # "credentials": { + # "username": "myusername" + # } + # } + # ``` + # + # Supported properties: image (required), env (object), options (string), ports (array), volumes (array), credentials (object with username). # - # All properties from GitHub's container specification are supported except credentials (use secrets instead). # See https://docs.github.com/en/actions/how-tos/write-workflows/choose-where-workflows-run/run-jobs-in-a-container # # When specified, steps will execute inside this container instead of checking out code. @@ -160,31 +173,43 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | -| | See . | | | | -| **`build`** | Build parameters. Must be a string or a JSON object. | **false** | **string** | `build` | -| | For string, provide a list of commands to run during the build step, one per line. | | | | -| | For JSON object, provide the following properties: | | | | -| | | | | | -| | - `commands`: Array of commands to run during the build step. | | | | -| | - `env`: Object of environment variables to set during the build step. | | | | -| | - `artifact`: String or array of strings specifying paths to artifacts to upload after the build | | | | -| | | | | | -| | Example: | | | | -| | 
{
 "commands": [
 "build",
 "generate-artifacts"
 ],
 "env": {
 "CUSTOM_ENV_VAR": "value"
 },
 "artifact": [
 "dist/",
 "packages/package-a/build/"
 ]
}
| | | | -| **`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). | | | | -| **`code-ql`** | Code QL analysis language. See . | **false** | **string** | `typescript` | -| **`dependency-review`** | Enable dependency review scan. See . | **false** | **boolean** | `true` | -| **`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). | | | | -| **`working-directory`** | Working directory where the dependencies are installed. | **false** | **string** | `.` | -| **`container`** | Container configuration to run CI steps in. Accepts string or JSON object. See Container Configuration below | **false** | **string** | - | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| | See . | | | | +| **`build`** | Build parameters. Must be a string or a JSON object. | **false** | **string** | `build` | +| | For string, provide a list of commands to run during the build step, one per line. | | | | +| | For JSON object, provide the following properties: | | | | +| | | | | | +| | - `commands`: Array of commands to run during the build step. | | | | +| | - `env`: Object of environment variables to set during the build step. | | | | +| | - `artifact`: String or array of strings specifying paths to artifacts to upload after the build | | | | +| | | | | | +| | Example: | | | | +| | 
{
 "commands": [
 "build",
 "generate-artifacts"
 ],
 "env": {
 "CUSTOM_ENV_VAR": "value"
 },
 "artifact": [
 "dist/",
 "packages/package-a/build/"
 ]
}
| | | | +| **`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). | | | | +| **`code-ql`** | Code QL analysis language. See . | **false** | **string** | `typescript` | +| **`dependency-review`** | Enable dependency review scan. See . | **false** | **boolean** | `true` | +| **`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). | | | | +| **`working-directory`** | Working directory where the dependencies are installed. | **false** | **string** | `.` | +| **`container`** | Container configuration to run CI steps in. | **false** | **string** | - | +| | Accepts either a string (container image name) or a JSON object with container options. | | | | +| | | | | | +| | String format (simple): | | | | +| | 
container: "node:18"
| | | | +| | JSON object format (advanced): | | | | +| | 
{
 "image": "node:18",
 "env": {
 "NODE_ENV": "production"
 },
 "options": "--cpus 2",
 "ports": [8080, 3000],
 "volumes": ["/tmp:/tmp", "/cache:/cache"],
 "credentials": {
 "username": "myusername"
 }
}
| | | | +| | Supported properties: image (required), env (object), options (string), ports (array), volumes (array), credentials (object with username). | | | | +| | | | | | +| | See | | | | +| | | | | | +| | When specified, steps will execute inside this container instead of checking out code. | | | | +| | The container should have the project code and dependencies pre-installed. | | | | @@ -253,14 +278,15 @@ When specified, steps will execute inside this container instead of checking out ## Secrets -| **Secret** | **Description** | **Required** | -| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -| **`build-secrets`** | Secrets to be used during the build step. | **false** | -| | Must be a multi-line env formatted string. | | -| | Example: | | -| | 
SECRET_EXAMPLE=$\{{ secrets.SECRET_EXAMPLE }}
| | -| **`container-password`** | Password or token for authenticating to the container registry. | **false** | -| | Required when using private container images. The username should be specified in the container input's `credentials.username` property. | | +| **Secret** | **Description** | **Required** | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ | +| **`build-secrets`** | Secrets to be used during the build step. | **false** | +| | Must be a multi-line env formatted string. | | +| | Example: | | +| | 
SECRET_EXAMPLE=$\{{ secrets.SECRET_EXAMPLE }}
| | +| **`container-password`** | Password for container registry authentication, if required. | **false** | +| | Used when the container image is hosted in a private registry. | | +| | See . | | @@ -291,7 +317,7 @@ on: jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@ce2bb8274a37c1219be2bcae2a1b2528c2c72957 # 0.19.0 permissions: id-token: write security-events: write @@ -357,7 +383,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@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@ce2bb8274a37c1219be2bcae2a1b2528c2c72957 # 0.19.0 permissions: id-token: write security-events: write @@ -387,7 +413,7 @@ on: jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@ce2bb8274a37c1219be2bcae2a1b2528c2c72957 # 0.19.0 permissions: id-token: write security-events: write diff --git a/actions/build/README.md b/actions/build/README.md index f6f462c..c4a465c 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@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/build@ce2bb8274a37c1219be2bcae2a1b2528c2c72957 # 0.19.0 with: # Working directory where the build commands are executed. # Can be absolute or relative to the repository root. @@ -39,7 +39,7 @@ 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: "" diff --git a/actions/dependencies-cache/README.md b/actions/dependencies-cache/README.md index 38bc104..fad7bf0 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@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/dependencies-cache@ce2bb8274a37c1219be2bcae2a1b2528c2c72957 # 0.19.0 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 883f710..52dcc68 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@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/get-package-manager@ce2bb8274a37c1219be2bcae2a1b2528c2c72957 # 0.19.0 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 4e11fd2..6bbea4b 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@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/has-installed-dependencies@ce2bb8274a37c1219be2bcae2a1b2528c2c72957 # 0.19.0 with: # The dependencies to check. # This input is required. diff --git a/actions/lint/README.md b/actions/lint/README.md index 9240947..4216595 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@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/lint@ce2bb8274a37c1219be2bcae2a1b2528c2c72957 # 0.19.0 with: # Working directory where lint commands are executed. # Can be absolute or relative to the repository root. diff --git a/actions/setup-node/README.md b/actions/setup-node/README.md index 5786565..55e1f3e 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@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@ce2bb8274a37c1219be2bcae2a1b2528c2c72957 # 0.19.0 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 5f349ae..77e597b 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@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0 +- uses: hoverkraft-tech/ci-github-nodejs/actions/test@ce2bb8274a37c1219be2bcae2a1b2528c2c72957 # 0.19.0 with: # Working directory where test commands are executed. # Can be absolute or relative to the repository root. @@ -43,9 +43,9 @@ Action to test Node.js projects with support for coverage reporting and pull req container: "false" # Code coverage reporter to use. Supported values: - # - "github": Use ReportGenerator for PR comments with coverage reports - # - "codecov": Upload coverage to Codecov - # - "": No coverage reporting + # - `github`: Use ReportGenerator for PR comments with coverage reports + # - `codecov`: Upload coverage to Codecov + # - `""` or `null`: No coverage reporting # # Default: `github` coverage: github @@ -60,7 +60,7 @@ Action to test Node.js projects with support for coverage reporting and pull req coverage-files: "" # GitHub token for coverage PR comments. - # Required when coverage is set to "github". + # Required when coverage is set to `github`. github-token: "" ``` @@ -75,9 +75,9 @@ Action to test Node.js projects with support for coverage reporting and pull req | | Can be absolute or relative to the repository root. | | | | **`container`** | Whether running in container mode (skips checkout and node setup) | **false** | `false` | | **`coverage`** | Code coverage reporter to use. Supported values: | **false** | `github` | -| | - "GitHub": Use ReportGenerator for PR comments with coverage reports | | | -| | - "Codecov": Upload coverage to Codecov | | | -| | - "": No coverage reporting | | | +| | - `github`: Use ReportGenerator for PR comments with coverage reports | | | +| | - `codecov`: Upload coverage to Codecov | | | +| | - `""` or `null`: No coverage reporting | | | | **`coverage-files`** | Path to coverage files for reporting. | **false** | - | | | Supports multiple formats (Cobertura, OpenCover, lcov, etc.). | | | | | Can be a single file or multiple files separated by semicolons. | | | @@ -86,7 +86,7 @@ Action to test Node.js projects with support for coverage reporting and pull req | | - coverage/lcov.info | | | | | - coverage/clover.xml | | | | **`github-token`** | GitHub token for coverage PR comments. | **false** | - | -| | Required when coverage is set to "GitHub". | | | +| | Required when coverage is set to `github`. | | |