From a5cb3017f39f1db5a35fdc831fdc784b049ff4d8 Mon Sep 17 00:00:00 2001 From: "hoverkraft-bot[bot]" <128996893+hoverkraft-bot[bot]@users.noreply.github.com> Date: Wed, 15 Oct 2025 17:17:36 +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 | 14 +++++++------- actions/dependencies-cache/README.md | 7 +++++-- actions/get-package-manager/README.md | 9 ++++++--- actions/has-installed-dependencies/README.md | 7 +++++-- actions/setup-node/README.md | 7 +++++-- 5 files changed, 28 insertions(+), 16 deletions(-) diff --git a/.github/workflows/continuous-integration.md b/.github/workflows/continuous-integration.md index d6d4178..336a9f7 100644 --- a/.github/workflows/continuous-integration.md +++ b/.github/workflows/continuous-integration.md @@ -3,7 +3,7 @@ # GitHub Reusable Workflow: Node.js Continuous Integration
- NodeJS Continuous Integration + Node.js Continuous Integration
--- @@ -43,7 +43,7 @@ Workflow to performs continuous integration steps agains a Node.js project: ## Usage ```yaml -name: NodeJS Continuous Integration +name: Node.js Continuous Integration on: push: branches: @@ -54,7 +54,7 @@ permissions: id-token: write jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@4b87508052fc8b08a44a5d2d7d5f0636deb6ea3e # 0.15.0 with: # Build parameters. Must be a string or a json object. # Default: `build` @@ -80,7 +80,7 @@ jobs: # Default: `true` test: true - # Specifify code coverage reporter. Supported values: 'codecov'. + # Specifify code coverage reporter. Supported values: `codecov`. # Default: `codecov` coverage: codecov @@ -99,13 +99,13 @@ jobs: | **Input** | **Description** | **Required** | **Type** | **Default** | | ----------------------- | ----------------------------------------------------------------------------------------- | ------------ | ----------- | ------------ | -| **`build`** | Build parameters. Must be a string or a JSON object. | **false** | **string** | `build` | +| **`build`** | Build parameters. Must be a string or a json object. | **false** | **string** | `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`** | Specifify code coverage reporter. Supported values: 'Codecov'. | **false** | **string** | `codecov` | +| **`coverage`** | Specifify code coverage reporter. Supported values: `codecov`. | **false** | **string** | `codecov` | | **`working-directory`** | Working directory where the dependencies are installed. | **false** | **string** | `.` | @@ -133,7 +133,7 @@ on: jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@4b87508052fc8b08a44a5d2d7d5f0636deb6ea3e # 0.15.0 permissions: id-token: write security-events: write diff --git a/actions/dependencies-cache/README.md b/actions/dependencies-cache/README.md index aaa4ee8..5df931d 100644 --- a/actions/dependencies-cache/README.md +++ b/actions/dependencies-cache/README.md @@ -3,7 +3,7 @@ # ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItYXJjaGl2ZSIgY29sb3I9ImdyYXktZGFyayI+PHBvbHlsaW5lIHBvaW50cz0iMjEgOCAyMSAyMSAzIDIxIDMgOCI+PC9wb2x5bGluZT48cmVjdCB4PSIxIiB5PSIzIiB3aWR0aD0iMjIiIGhlaWdodD0iNSI+PC9yZWN0PjxsaW5lIHgxPSIxMCIgeTE9IjEyIiB4Mj0iMTQiIHkyPSIxMiI+PC9saW5lPjwvc3ZnPg==) GitHub Action: Dependencies cache
- Dependencies cache + Dependencies cache
--- @@ -33,13 +33,15 @@ Action to setup dependencies cache managment. ## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs/actions/dependencies-cache@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1 +- uses: hoverkraft-tech/ci-github-nodejs/actions/dependencies-cache@4b87508052fc8b08a44a5d2d7d5f0636deb6ea3e # 0.15.0 with: # List of dependencies for which the cache should be managed. # This input is required. dependencies: "" # Working directory where the dependencies are installed. + # Can be absolute or relative to the repository root. + # # Default: `.` working-directory: . ``` @@ -54,6 +56,7 @@ Action to setup dependencies cache managment. | ----------------------- | ----------------------------------------------------------- | ------------ | ----------- | | **`dependencies`** | List of dependencies for which the cache should be managed. | **true** | - | | **`working-directory`** | Working directory where the dependencies are installed. | **false** | `.` | +| | Can be absolute or relative to the repository root. | | | diff --git a/actions/get-package-manager/README.md b/actions/get-package-manager/README.md index 1a51164..8957ad7 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
--- @@ -24,7 +24,7 @@ ## Overview -Action to detect the package manager used. Supports Yarn and npm +Action to detect the package manager used. Supports Yarn, pnpm, and npm @@ -33,9 +33,11 @@ Action to detect the package manager used. Supports Yarn and npm ## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs/actions/get-package-manager@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1 +- uses: hoverkraft-tech/ci-github-nodejs/actions/get-package-manager@4b87508052fc8b08a44a5d2d7d5f0636deb6ea3e # 0.15.0 with: # Working directory where the dependencies are installed. + # Can be absolute or relative to the repository root. + # # Default: `.` working-directory: . ``` @@ -49,6 +51,7 @@ Action to detect the package manager used. Supports Yarn and npm | **Input** | **Description** | **Required** | **Default** | | ----------------------- | ------------------------------------------------------- | ------------ | ----------- | | **`working-directory`** | Working directory where the dependencies are installed. | **false** | `.` | +| | 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 a1052b2..ff4554c 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,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItc2V0dGluZ3MiIGNvbG9yPSJncmF5LWRhcmsiPjxjaXJjbGUgY3g9IjEyIiBjeT0iMTIiIHI9IjMiPjwvY2lyY2xlPjxwYXRoIGQ9Ik0xOS40IDE1YTEuNjUgMS42NSAwIDAgMCAuMzMgMS44MmwuMDYuMDZhMiAyIDAgMCAxIDAgMi44MyAyIDIgMCAwIDEtMi44MyAwbC0uMDYtLjA2YTEuNjUgMS42NSAwIDAgMC0xLjgyLS4zMyAxLjY1IDEuNjUgMCAwIDAtMSAxLjUxVjIxYTIgMiAwIDAgMS0yIDIgMiAyIDAgMCAxLTItMnYtLjA5QTEuNjUgMS42NSAwIDAgMCA5IDE5LjRhMS42NSAxLjY1IDAgMCAwLTEuODIuMzNsLS4wNi4wNmEyIDIgMCAwIDEtMi44MyAwIDIgMiAwIDAgMSAwLTIuODNsLjA2LS4wNmExLjY1IDEuNjUgMCAwIDAgLjMzLTEuODIgMS42NSAxLjY1IDAgMCAwLTEuNTEtMUgzYTIgMiAwIDAgMS0yLTIgMiAyIDAgMCAxIDItMmguMDlBMS42NSAxLjY1IDAgMCAwIDQuNiA5YTEuNjUgMS42NSAwIDAgMC0uMzMtMS44MmwtLjA2LS4wNmEyIDIgMCAwIDEgMC0yLjgzIDIgMiAwIDAgMSAyLjgzIDBsLjA2LjA2YTEuNjUgMS42NSAwIDAgMCAxLjgyLjMzSDlhMS42NSAxLjY1IDAgMCAwIDEtMS41MVYzYTIgMiAwIDAgMSAyLTIgMiAyIDAgMCAxIDIgMnYuMDlhMS42NSAxLjY1IDAgMCAwIDEgMS41MSAxLjY1IDEuNjUgMCAwIDAgMS44Mi0uMzNsLjA2LS4wNmEyIDIgMCAwIDEgMi44MyAwIDIgMiAwIDAgMSAwIDIuODNsLS4wNi4wNmExLjY1IDEuNjUgMCAwIDAtLjMzIDEuODJWOWExLjY1IDEuNjUgMCAwIDAgMS41MSAxSDIxYTIgMiAwIDAgMSAyIDIgMiAyIDAgMCAxLTIgMmgtLjA5YTEuNjUgMS42NSAwIDAgMC0xLjUxIDF6Ij48L3BhdGg+PC9zdmc+) GitHub Action: Has installed dependencies
- Has installed dependencies + Has installed dependencies
--- @@ -33,13 +33,15 @@ 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@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1 +- uses: hoverkraft-tech/ci-github-nodejs/actions/has-installed-dependencies@4b87508052fc8b08a44a5d2d7d5f0636deb6ea3e # 0.15.0 with: # The dependencies to check. # This input is required. dependencies: "" # Working directory where the dependencies are installed. + # Can be absolute or relative to the repository root. + # # Default: `.` working-directory: . ``` @@ -54,6 +56,7 @@ Action to check if dependencies have been installed according to the package man | ----------------------- | ------------------------------------------------------- | ------------ | ----------- | | **`dependencies`** | The dependencies to check. | **true** | - | | **`working-directory`** | Working directory where the dependencies are installed. | **false** | `.` | +| | Can be absolute or relative to the repository root. | | | diff --git a/actions/setup-node/README.md b/actions/setup-node/README.md index d2dce4b..a85b2e7 100644 --- a/actions/setup-node/README.md +++ b/actions/setup-node/README.md @@ -3,7 +3,7 @@ # ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItc2V0dGluZ3MiIGNvbG9yPSJncmF5LWRhcmsiPjxjaXJjbGUgY3g9IjEyIiBjeT0iMTIiIHI9IjMiPjwvY2lyY2xlPjxwYXRoIGQ9Ik0xOS40IDE1YTEuNjUgMS42NSAwIDAgMCAuMzMgMS44MmwuMDYuMDZhMiAyIDAgMCAxIDAgMi44MyAyIDIgMCAwIDEtMi44MyAwbC0uMDYtLjA2YTEuNjUgMS42NSAwIDAgMC0xLjgyLS4zMyAxLjY1IDEuNjUgMCAwIDAtMSAxLjUxVjIxYTIgMiAwIDAgMS0yIDIgMiAyIDAgMCAxLTItMnYtLjA5QTEuNjUgMS42NSAwIDAgMCA5IDE5LjRhMS42NSAxLjY1IDAgMCAwLTEuODIuMzNsLS4wNi4wNmEyIDIgMCAwIDEtMi44MyAwIDIgMiAwIDAgMSAwLTIuODNsLjA2LS4wNmExLjY1IDEuNjUgMCAwIDAgLjMzLTEuODIgMS42NSAxLjY1IDAgMCAwLTEuNTEtMUgzYTIgMiAwIDAgMS0yLTIgMiAyIDAgMCAxIDItMmguMDlBMS42NSAxLjY1IDAgMCAwIDQuNiA5YTEuNjUgMS42NSAwIDAgMC0uMzMtMS44MmwtLjA2LS4wNmEyIDIgMCAwIDEgMC0yLjgzIDIgMiAwIDAgMSAyLjgzIDBsLjA2LjA2YTEuNjUgMS42NSAwIDAgMCAxLjgyLjMzSDlhMS42NSAxLjY1IDAgMCAwIDEtMS41MVYzYTIgMiAwIDAgMSAyLTIgMiAyIDAgMCAxIDIgMnYuMDlhMS42NSAxLjY1IDAgMCAwIDEgMS41MSAxLjY1IDEuNjUgMCAwIDAgMS44Mi0uMzNsLjA2LS4wNmEyIDIgMCAwIDEgMi44MyAwIDIgMiAwIDAgMSAwIDIuODNsLS4wNi4wNmExLjY1IDEuNjUgMCAwIDAtLjMzIDEuODJWOWExLjY1IDEuNjUgMCAwIDAgMS41MSAxSDIxYTIgMiAwIDAgMSAyIDIgMiAyIDAgMCAxLTIgMmgtLjA5YTEuNjUgMS42NSAwIDAgMC0xLjUxIDF6Ij48L3BhdGg+PC9zdmc+) GitHub Action: Setup Node.js
- Setup Node.js + Setup Node.js
--- @@ -33,12 +33,14 @@ Action to setup Node.js and install dependencies according to the package manage ## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1 +- uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@4b87508052fc8b08a44a5d2d7d5f0636deb6ea3e # 0.15.0 with: # List of dependencies for which the cache should be managed dependencies-cache: "" # Working directory where the dependencies are installed. + # Can be absolute or relative to the repository root. + # # Default: `.` working-directory: . ``` @@ -53,6 +55,7 @@ Action to setup Node.js and install dependencies according to the package manage | ------------------------ | ---------------------------------------------------------- | ------------ | ----------- | | **`dependencies-cache`** | List of dependencies for which the cache should be managed | **false** | - | | **`working-directory`** | Working directory where the dependencies are installed. | **false** | `.` | +| | Can be absolute or relative to the repository root. | | |