From f32d92206d728fbb77f078f5528c55f580f9876a Mon Sep 17 00:00:00 2001 From: "hoverkraft-bot[bot]" <128996893+hoverkraft-bot[bot]@users.noreply.github.com> Date: Wed, 29 Oct 2025 13:28:54 +0000 Subject: [PATCH] docs: update actions and workflows documentation [skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .github/workflows/continuous-integration.md | 56 ++++++++++++--------- actions/get-package-manager/README.md | 2 +- 2 files changed, 33 insertions(+), 25 deletions(-) diff --git a/.github/workflows/continuous-integration.md b/.github/workflows/continuous-integration.md index 5865a29..c2e7c48 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
--- @@ -54,7 +54,7 @@ permissions: id-token: write jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@acb0215bd991fe9aa6e8309fe0612620f40186f8 # copilot/update-workflow-for-docker-image + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@4d7c1ed87c18493fc4c2dbae4dbde46cf251c9a7 # 0.16.1 secrets: # Secrets to be used during the build step. # Must be a multi-line env formatted string. @@ -64,6 +64,12 @@ jobs: # ``` build-secrets: "" with: + # JSON array of runner(s) to use. + # See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job. + # + # Default: `["ubuntu-latest"]` + runs-on: '["ubuntu-latest"]' + # Build parameters. Must be a string or a JSON object. # For string, provide a list of commands to run during the build step, one per line. # For JSON object, provide the following properties: @@ -132,26 +138,28 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ------------ | -| **`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`** | Optional flag to enable linting. | **false** | **boolean** | `true` | -| **`code-ql`** | Code QL analysis language. See . | **false** | **string** | `typescript` | -| **`dependency-review`** | Enable dependency review scan. See . | **false** | **boolean** | `true` | -| **`test`** | Optional flag to enable test. | **false** | **boolean** | `true` | -| **`coverage`** | Specify code coverage reporter. Supported values: `codecov`. | **false** | **string** | `codecov` | -| **`working-directory`** | Working directory where the dependencies are installed. | **false** | **string** | `.` | -| **`container`** | Docker container image to run CI steps in. When specified, steps will execute inside this container instead of checking out code. The container should have the project code and dependencies pre-installed. | **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`** | Optional flag to enable linting. | **false** | **boolean** | `true` | +| **`code-ql`** | Code QL analysis language. See . | **false** | **string** | `typescript` | +| **`dependency-review`** | Enable dependency review scan. See . | **false** | **boolean** | `true` | +| **`test`** | Optional flag to enable test. | **false** | **boolean** | `true` | +| **`coverage`** | Specify code coverage reporter. Supported values: `codecov`. | **false** | **string** | `codecov` | +| **`working-directory`** | Working directory where the dependencies are installed. | **false** | **string** | `.` | +| **`container`** | Docker container image to run CI steps in. When specified, steps will execute inside this container instead of checking out code. The container should have the project code and dependencies pre-installed. | **false** | **string** | - | @@ -188,7 +196,7 @@ on: jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@acb0215bd991fe9aa6e8309fe0612620f40186f8 # copilot/update-workflow-for-docker-image + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@4d7c1ed87c18493fc4c2dbae4dbde46cf251c9a7 # 0.16.1 permissions: id-token: write security-events: write @@ -254,7 +262,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@acb0215bd991fe9aa6e8309fe0612620f40186f8 # copilot/update-workflow-for-docker-image + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@4d7c1ed87c18493fc4c2dbae4dbde46cf251c9a7 # 0.16.1 permissions: id-token: write security-events: write diff --git a/actions/get-package-manager/README.md b/actions/get-package-manager/README.md index 4b46b96..363c2c4 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,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItcGFja2FnZSIgY29sb3I9ImdyYXktZGFyayI+PGxpbmUgeDE9IjE2LjUiIHkxPSI5LjQiIHgyPSI3LjUiIHkyPSI0LjIxIj48L2xpbmU+PHBhdGggZD0iTTIxIDE2VjhhMiAyIDAgMCAwLTEtMS43M2wtNy00YTIgMiAwIDAgMC0yIDBsLTcgNEEyIDIgMCAwIDAgMyA4djhhMiAyIDAgMCAwIDEgMS43M2w3IDRhMiAyIDAgMCAwIDIgMGw3LTRBMiAyIDAgMCAwIDIxIDE2eiI+PC9wYXRoPjxwb2x5bGluZSBwb2ludHM9IjMuMjcgNi45NiAxMiAxMi4wMSAyMC43MyA2Ljk2Ij48L3BvbHlsaW5lPjxsaW5lIHgxPSIxMiIgeTE9IjIyLjA4IiB4Mj0iMTIiIHkyPSIxMiI+PC9saW5lPjwvc3ZnPg==) GitHub Action: Get package manager
- Get package manager + Get package manager
---