From 37fd546048d3611555c096d163cb0cd267d75299 Mon Sep 17 00:00:00 2001 From: "hoverkraft-bot[bot]" <128996893+hoverkraft-bot[bot]@users.noreply.github.com> Date: Fri, 10 Jul 2026 16:11:29 +0000 Subject: [PATCH] docs(hoverkraft-tech/ci-github-nodejs): update documentation Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../ci-github-nodejs/CONTRIBUTING.md | 10 +- .../ci-github-nodejs/actions/build/index.md | 4 +- .../ci-github-nodejs/actions/codecov/index.md | 4 +- .../actions/dependencies-cache/index.md | 4 +- .../actions/get-package-manager/index.md | 4 +- .../has-installed-dependencies/index.md | 4 +- .../ci-github-nodejs/actions/lint/index.md | 4 +- .../ci-github-nodejs/actions/package/index.md | 4 +- .../actions/setup-node/index.md | 16 +- .../ci-github-nodejs/actions/test/index.md | 4 +- .../ci-github-nodejs/github/_index.md | 6 +- .../workflows/continuous-integration.md | 50 +++---- .../github/workflows/release.md | 34 ++--- .../ci-github-nodejs/index.md | 20 +-- application/docs/projects/index.mdx | 140 +++++++++--------- 15 files changed, 154 insertions(+), 154 deletions(-) diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/CONTRIBUTING.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/CONTRIBUTING.md index 99b11e14e..bd536d6b5 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/CONTRIBUTING.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/CONTRIBUTING.md @@ -2,8 +2,8 @@ source_repo: hoverkraft-tech/ci-github-nodejs source_path: CONTRIBUTING.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- # Contributing @@ -17,11 +17,11 @@ Please note we have a code of conduct, please follow it in all your interactions 1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. -2. Update the README.md with details of changes to the interface, this includes new environment +1. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters. -3. Increase the version numbers in any examples files and the README.md to the new version that this +1. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). -4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you +1. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. ## Code of Conduct diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/build/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/build/index.md index fb429339a..ca03e6cc2 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/build/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/build/index.md @@ -3,8 +3,8 @@ title: Build source_repo: hoverkraft-tech/ci-github-nodejs source_path: actions/build/README.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/codecov/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/codecov/index.md index 82365f7f3..95cae0884 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/codecov/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/codecov/index.md @@ -3,8 +3,8 @@ title: Codecov source_repo: hoverkraft-tech/ci-github-nodejs source_path: actions/codecov/README.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/dependencies-cache/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/dependencies-cache/index.md index 5aa52f4b4..5d5387d5a 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/dependencies-cache/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/dependencies-cache/index.md @@ -3,8 +3,8 @@ title: Dependencies Cache source_repo: hoverkraft-tech/ci-github-nodejs source_path: actions/dependencies-cache/README.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/get-package-manager/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/get-package-manager/index.md index a88963731..e6f8a34dd 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/get-package-manager/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/get-package-manager/index.md @@ -3,8 +3,8 @@ title: Get Package Manager source_repo: hoverkraft-tech/ci-github-nodejs source_path: actions/get-package-manager/README.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/has-installed-dependencies/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/has-installed-dependencies/index.md index c5133cfbf..cdaace4f2 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/has-installed-dependencies/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/has-installed-dependencies/index.md @@ -3,8 +3,8 @@ title: Has Installed Dependencies source_repo: hoverkraft-tech/ci-github-nodejs source_path: actions/has-installed-dependencies/README.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/lint/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/lint/index.md index c09d856bb..77da5efef 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/lint/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/lint/index.md @@ -3,8 +3,8 @@ title: Lint source_repo: hoverkraft-tech/ci-github-nodejs source_path: actions/lint/README.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/package/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/package/index.md index 591ea6e89..f17c6721c 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/package/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/package/index.md @@ -3,8 +3,8 @@ title: Package source_repo: hoverkraft-tech/ci-github-nodejs source_path: actions/package/README.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/setup-node/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/setup-node/index.md index ce816392e..41722488b 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/setup-node/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/setup-node/index.md @@ -3,8 +3,8 @@ title: Setup Node source_repo: hoverkraft-tech/ci-github-nodejs source_path: actions/setup-node/README.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- @@ -65,12 +65,12 @@ Action to setup Node.js and install dependencies according to the package manage ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | -| **`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. | | | -| **`registry-url`** | Optional registry to set up for auth. | **false** | - | +| **Input** | **Description** | **Required** | **Default** | +| ------------------------ | --------------------------------------------------------------------- | ------------ | ----------- | +| **`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. | | | +| **`registry-url`** | Optional registry to set up for auth. | **false** | - | | | See [https://github.com/actions/setup-node?tab=readme-ov-file#usage](https://github.com/actions/setup-node?tab=readme-ov-file#usage). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/test/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/test/index.md index 903a35b42..23fb192fa 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/test/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/actions/test/index.md @@ -3,8 +3,8 @@ title: Test source_repo: hoverkraft-tech/ci-github-nodejs source_path: actions/test/README.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/github/_index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/github/_index.md index ff55bd10a..7289dea96 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/github/_index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/github/_index.md @@ -1,7 +1,7 @@ --- -title: Github -description: Overview for Github -sidebar_label: Github +title: GitHub +description: Overview for GitHub +sidebar_label: GitHub --- This page is generated automatically to introduce the GitHub documentation section. diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/github/workflows/continuous-integration.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/github/workflows/continuous-integration.md index d284c5325..5e7afadf3 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/github/workflows/continuous-integration.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/github/workflows/continuous-integration.md @@ -2,8 +2,8 @@ source_repo: hoverkraft-tech/ci-github-nodejs source_path: .github/workflows/continuous-integration.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- @@ -11,7 +11,7 @@ last_synced: 2026-06-06T06:50:14.639Z # GitHub Reusable Workflow: Node.js Continuous Integration
- Node.js Continuous Integration + Node.js Continuous Integration
--- @@ -62,7 +62,7 @@ on: permissions: {} jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@37a362e984a1841a2be36e2f85b68755dc01d056 # 0.24.3 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@df348077afa4e79725151d50606e9dc63f86dcb6 # 0.24.4 permissions: contents: read id-token: write @@ -233,7 +233,7 @@ jobs: | **Input** | **Description** | **Required** | **Type** | **Default** | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ------------------- | | **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | -| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | +| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | | **`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: | | | | @@ -247,20 +247,20 @@ 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/index.md). | | | | +| | Accepts a JSON object for lint options. See [lint action](../../actions/lint/index.md). | | | | | | It should generate lint reports in standard formats. | | | | | | | | | | | | Example: | | | | | | | | | | | | 
{
 "lint:ci": "eslint . --output-file eslint-report.json --format json"
}
| | | | | **`code-ql`** | Code QL analysis language. | **false** | **string** | `typescript` | -| | See [https://github.com/github/codeql-action](https://github.com/github/codeql-action). | | | | +| | See [https://github.com/github/codeql-action](https://github.com/github/codeql-action). | | | | | **`dependency-review`** | Enable dependency review scan. | **false** | **boolean** | `true` | | | Works with public repositories and private repositories with a GitHub Advanced Security license. | | | | -| | See [https://github.com/actions/dependency-review-action](https://github.com/actions/dependency-review-action). | | | | +| | See [https://github.com/actions/dependency-review-action](https://github.com/actions/dependency-review-action). | | | | | **`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/index.md). | | | | +| | Accepts a JSON object for test options. See [test action](../../actions/test/index.md). | | | | | | If coverage is enabled, it should generate test and coverage reports in standard formats. | | | | | | | | | | | | Example: | | | | @@ -286,7 +286,7 @@ jobs: | | - `credentials` (object with `username`). | | | | | | - `pathMapping` (object) path mapping from container paths to repository paths. Defaults is working directory is mapped with repository root. | | | | | | | | | | -| | See [https://docs.github.com/en/actions/how-tos/write-workflows/choose-where-workflows-run/run-jobs-in-a-container](https://docs.github.com/en/actions/how-tos/write-workflows/choose-where-workflows-run/run-jobs-in-a-container). | | | | +| | See [https://docs.github.com/en/actions/how-tos/write-workflows/choose-where-workflows-run/run-jobs-in-a-container](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. | | | | | | The container should have the project code and dependencies pre-installed. | | | | @@ -360,17 +360,17 @@ 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 for container registry authentication, if required. | **false** | -| | Used when the container image is hosted in a private registry. | | +| **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 [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](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). | | -| **`github-token`** | GitHub token to use for authentication. | **false** | -| | Defaults to `GITHUB_TOKEN` if not provided. | | +| **`github-token`** | GitHub token to use for authentication. | **false** | +| | Defaults to `GITHUB_TOKEN` if not provided. | | @@ -401,7 +401,7 @@ on: jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@37a362e984a1841a2be36e2f85b68755dc01d056 # 0.24.3 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@df348077afa4e79725151d50606e9dc63f86dcb6 # 0.24.4 permissions: id-token: write security-events: write @@ -467,7 +467,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@37a362e984a1841a2be36e2f85b68755dc01d056 # 0.24.3 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@df348077afa4e79725151d50606e9dc63f86dcb6 # 0.24.4 permissions: id-token: write security-events: write @@ -491,7 +491,7 @@ on: branches: [main] jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@37a362e984a1841a2be36e2f85b68755dc01d056 # 0.24.3 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@df348077afa4e79725151d50606e9dc63f86dcb6 # 0.24.4 permissions: id-token: write security-events: write @@ -519,7 +519,7 @@ on: jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@37a362e984a1841a2be36e2f85b68755dc01d056 # 0.24.3 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@df348077afa4e79725151d50606e9dc63f86dcb6 # 0.24.4 permissions: id-token: write security-events: write @@ -539,7 +539,7 @@ jobs: "volumes": ["/tmp:/tmp", "/cache:/workspace/cache"], "credentials": { "username": "myusername" - } + } } ``` diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/github/workflows/release.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/github/workflows/release.md index d9c069480..270196a65 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/github/workflows/release.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/github/workflows/release.md @@ -2,8 +2,8 @@ source_repo: hoverkraft-tech/ci-github-nodejs source_path: .github/workflows/release.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- @@ -110,22 +110,22 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ---------------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| --------------------------------- | ---------------------------------------------------------------------------------- | ------------ | ----------- | ---------------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | | | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | -| **`package-tarball-artifact-id`** | Artifact ID of the package tarball produced by CI. | **true** | **string** | - | -| **`registry-url`** | Registry URL used by npm publish. | **false** | **string** | `https://registry.npmjs.org` | -| **`access`** | Package access level passed to npm publish. Leave empty to use npm defaults. | **false** | **string** | `public` | -| **`tag`** | npm distribution tag for the published package. Leave empty to use npm defaults. | **false** | **string** | - | -| | Common values: | | | | -| | - `latest` - Default tag for stable releases | | | | -| | - `next` - Prerelease or beta versions | | | | -| | - `canary` - Canary/nightly builds | | | | -| | | | | | -| | See [https://docs.npmjs.com/adding-dist-tags-to-packages](https://docs.npmjs.com/adding-dist-tags-to-packages). | | | | -| **`provenance`** | Whether to generate npm provenance for npmjs.org publishes. | **false** | **boolean** | `true` | -| **`dry-run`** | Whether to run npm publish without publishing the package. | **false** | **boolean** | `false` | +| **`package-tarball-artifact-id`** | Artifact ID of the package tarball produced by CI. | **true** | **string** | - | +| **`registry-url`** | Registry URL used by npm publish. | **false** | **string** | `https://registry.npmjs.org` | +| **`access`** | Package access level passed to npm publish. Leave empty to use npm defaults. | **false** | **string** | `public` | +| **`tag`** | npm distribution tag for the published package. Leave empty to use npm defaults. | **false** | **string** | - | +| | Common values: | | | | +| | - `latest` - Default tag for stable releases | | | | +| | - `next` - Prerelease or beta versions | | | | +| | - `canary` - Canary/nightly builds | | | | +| | | | | | +| | See [https://docs.npmjs.com/adding-dist-tags-to-packages](https://docs.npmjs.com/adding-dist-tags-to-packages). | | | | +| **`provenance`** | Whether to generate npm provenance for npmjs.org publishes. | **false** | **boolean** | `true` | +| **`dry-run`** | Whether to run npm publish without publishing the package. | **false** | **boolean** | `false` | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/index.md index 3bc9a2083..d6f42f9b0 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/index.md @@ -1,10 +1,10 @@ --- -title: Ci Github Nodejs +title: Ci GitHub Nodejs source_repo: hoverkraft-tech/ci-github-nodejs source_path: README.md source_branch: main -source_run_id: 27055302207 -last_synced: 2026-06-06T06:50:14.639Z +source_run_id: 29105904746 +last_synced: 2026-07-10T16:11:09.572Z --- # Continuous Integration - GitHub - Node.js @@ -88,13 +88,13 @@ actions/{category}/{action-name}/ #### Action Definition Standards 1. **Consistent branding**: Use `author: hoverkraft` with `color: blue` and a meaningful `icon`. -2. **Pinned dependencies**: Reference third-party actions via exact SHAs to guarantee reproducibility. -3. **Input validation**: Validate critical inputs early within composite steps or supporting scripts. -4. **Idempotent steps**: Ensure actions can run multiple times without leaving residual state in the workspace. -5. **Multi-platform support**: Test actions in both `ubuntu-latest` and `windows-latest` runners when applicable. -6. **Cross-platform compatibility**: Uses `actions/github-script` steps for cross-platform compatibility. Avoid `run` steps. -7. **Logging**: Use structured logs with clear prefixes (`[build-image]`, `[helm-test-chart]`, …) to simplify debugging. -8. **Security**: Avoid shell interpolation with untrusted inputs; prefer parameterized commands or `set -euo pipefail` wrappers. +1. **Pinned dependencies**: Reference third-party actions via exact SHAs to guarantee reproducibility. +1. **Input validation**: Validate critical inputs early within composite steps or supporting scripts. +1. **Idempotent steps**: Ensure actions can run multiple times without leaving residual state in the workspace. +1. **Multi-platform support**: Test actions in both `ubuntu-latest` and `windows-latest` runners when applicable. +1. **Cross-platform compatibility**: Uses `actions/github-script` steps for cross-platform compatibility. Avoid `run` steps. +1. **Logging**: Use structured logs with clear prefixes (`[build-image]`, `[helm-test-chart]`, …) to simplify debugging. +1. **Security**: Avoid shell interpolation with untrusted inputs; prefer parameterized commands or `set -euo pipefail` wrappers. #### File Conventions diff --git a/application/docs/projects/index.mdx b/application/docs/projects/index.mdx index 4861b62a3..26e1c4f5d 100644 --- a/application/docs/projects/index.mdx +++ b/application/docs/projects/index.mdx @@ -20,13 +20,13 @@ export const projectSections = [ icon: '⚡', - title: 'ci-github-common', + title: 'ci-github-nodejs', - titleHref: 'https://github.com/hoverkraft-tech/ci-github-common', + titleHref: 'https://github.com/hoverkraft-tech/ci-github-nodejs', - meta: 'JavaScript • ⭐ 4 • Updated Jul 9, 2026', + meta: 'Makefile • ⭐ 1 • Updated Jul 10, 2026', - description: 'Opinionated GitHub actions and workflows for common continuous integration needs', + description: 'Opinionated Github actions and workflows for continuous integration in NodeJs context', tags: [ @@ -34,9 +34,9 @@ export const projectSections = [ 'github-actions', - 'open-source', + 'node', - 'workflow' + 'open-source' ], @@ -46,7 +46,7 @@ export const projectSections = [ label: 'View on GitHub', - href: 'https://github.com/hoverkraft-tech/ci-github-common' + href: 'https://github.com/hoverkraft-tech/ci-github-nodejs' }, @@ -54,7 +54,7 @@ export const projectSections = [ label: 'Documentation', - href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-common/' + href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/' } @@ -66,21 +66,17 @@ export const projectSections = [ icon: '⚡', - title: 'ci-github-publish', + title: 'ci-dokumentor', - titleHref: 'https://github.com/hoverkraft-tech/ci-github-publish', + titleHref: 'https://github.com/hoverkraft-tech/ci-dokumentor', - meta: 'JavaScript • ⭐ 5 • Updated Jul 3, 2026', + meta: 'TypeScript • ⭐ 5 • Updated Jul 10, 2026', - description: 'Opinionated GitHub actions and workflows for streamlined release, deployment, and publishing.', + description: 'Automated documentation generator for CI/CD components', tags: [ - 'continuous-delivery', - - 'continuous-deployment', - - 'continuous-integration', + 'documentation', 'github-actions', @@ -94,7 +90,7 @@ export const projectSections = [ label: 'View on GitHub', - href: 'https://github.com/hoverkraft-tech/ci-github-publish' + href: 'https://github.com/hoverkraft-tech/ci-dokumentor' }, @@ -102,7 +98,7 @@ export const projectSections = [ label: 'Documentation', - href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/' + href: 'https://hoverkraft-tech.github.io/ci-dokumentor/' } @@ -114,23 +110,25 @@ export const projectSections = [ icon: '⚡', - title: 'ci-github-nodejs', + title: 'ci-github-container', - titleHref: 'https://github.com/hoverkraft-tech/ci-github-nodejs', + titleHref: 'https://github.com/hoverkraft-tech/ci-github-container', - meta: 'Makefile • ⭐ 1 • Updated Jul 3, 2026', + meta: 'Go Template • ⭐ 5 • Updated Jul 10, 2026', - description: 'Opinionated Github actions and workflows for continuous integration in NodeJs context', + description: 'Opinionated GitHub Actions and workflows for continuous integration in container (OCI) context', tags: [ - 'continuous-integration', + 'build', - 'github-actions', + 'containers', - 'node', + 'continuous-integration', - 'open-source' + 'docker', + + 'github-actions' ], @@ -140,7 +138,7 @@ export const projectSections = [ label: 'View on GitHub', - href: 'https://github.com/hoverkraft-tech/ci-github-nodejs' + href: 'https://github.com/hoverkraft-tech/ci-github-container' }, @@ -148,7 +146,7 @@ export const projectSections = [ label: 'Documentation', - href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-nodejs/' + href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-container/' } @@ -160,25 +158,23 @@ export const projectSections = [ icon: '⚡', - title: 'ci-github-container', + title: 'ci-github-common', - titleHref: 'https://github.com/hoverkraft-tech/ci-github-container', + titleHref: 'https://github.com/hoverkraft-tech/ci-github-common', - meta: 'Go Template • ⭐ 5 • Updated Jul 1, 2026', + meta: 'JavaScript • ⭐ 4 • Updated Jul 9, 2026', - description: 'Opinionated GitHub Actions and workflows for continuous integration in container (OCI) context', + description: 'Opinionated GitHub actions and workflows for common continuous integration needs', tags: [ - 'build', - - 'containers', - 'continuous-integration', - 'docker', + 'github-actions', - 'github-actions' + 'open-source', + + 'workflow' ], @@ -188,7 +184,7 @@ export const projectSections = [ label: 'View on GitHub', - href: 'https://github.com/hoverkraft-tech/ci-github-container' + href: 'https://github.com/hoverkraft-tech/ci-github-common' }, @@ -196,7 +192,7 @@ export const projectSections = [ label: 'Documentation', - href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-container/' + href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-common/' } @@ -208,25 +204,25 @@ export const projectSections = [ icon: '⚡', - title: 'github-action-ovh-mks-scaling', + title: 'ci-github-publish', - titleHref: 'https://github.com/hoverkraft-tech/github-action-ovh-mks-scaling', + titleHref: 'https://github.com/hoverkraft-tech/ci-github-publish', - meta: 'TypeScript • ⭐ 2 • Updated Jun 29, 2026', + meta: 'JavaScript • ⭐ 5 • Updated Jul 3, 2026', - description: 'Scale up or down a OVH MKS nodepool', + description: 'Opinionated GitHub actions and workflows for streamlined release, deployment, and publishing.', tags: [ - 'github-actions', + 'continuous-delivery', - 'kubernetes', + 'continuous-deployment', - 'mks', + 'continuous-integration', - 'open-source', + 'github-actions', - 'ovhcloud' + 'open-source' ], @@ -236,7 +232,7 @@ export const projectSections = [ label: 'View on GitHub', - href: 'https://github.com/hoverkraft-tech/github-action-ovh-mks-scaling' + href: 'https://github.com/hoverkraft-tech/ci-github-publish' }, @@ -244,7 +240,7 @@ export const projectSections = [ label: 'Documentation', - href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/github-action-ovh-mks-scaling/' + href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-publish/' } @@ -256,23 +252,25 @@ export const projectSections = [ icon: '⚡', - title: 'compose-action', + title: 'github-action-ovh-mks-scaling', - titleHref: 'https://github.com/hoverkraft-tech/compose-action', + titleHref: 'https://github.com/hoverkraft-tech/github-action-ovh-mks-scaling', - meta: 'TypeScript • ⭐ 210 • Updated Jun 26, 2026', + meta: 'TypeScript • ⭐ 2 • Updated Jun 29, 2026', - description: 'This action runs your docker-compose file and clean up before action finished', + description: 'Scale up or down a OVH MKS nodepool', tags: [ - 'continuous-integration', + 'github-actions', - 'docker-compose', + 'kubernetes', - 'github-actions', + 'mks', - 'open-source' + 'open-source', + + 'ovhcloud' ], @@ -282,7 +280,7 @@ export const projectSections = [ label: 'View on GitHub', - href: 'https://github.com/hoverkraft-tech/compose-action' + href: 'https://github.com/hoverkraft-tech/github-action-ovh-mks-scaling' }, @@ -290,7 +288,7 @@ export const projectSections = [ label: 'Documentation', - href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/compose-action/' + href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/github-action-ovh-mks-scaling/' } @@ -302,17 +300,19 @@ export const projectSections = [ icon: '⚡', - title: 'ci-dokumentor', + title: 'compose-action', - titleHref: 'https://github.com/hoverkraft-tech/ci-dokumentor', + titleHref: 'https://github.com/hoverkraft-tech/compose-action', - meta: 'TypeScript • ⭐ 5 • Updated Jun 13, 2026', + meta: 'TypeScript • ⭐ 210 • Updated Jun 26, 2026', - description: 'Automated documentation generator for CI/CD components', + description: 'This action runs your docker-compose file and clean up before action finished', tags: [ - 'documentation', + 'continuous-integration', + + 'docker-compose', 'github-actions', @@ -326,7 +326,7 @@ export const projectSections = [ label: 'View on GitHub', - href: 'https://github.com/hoverkraft-tech/ci-dokumentor' + href: 'https://github.com/hoverkraft-tech/compose-action' }, @@ -334,7 +334,7 @@ export const projectSections = [ label: 'Documentation', - href: 'https://hoverkraft-tech.github.io/ci-dokumentor/' + href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/compose-action/' } @@ -1524,7 +1524,7 @@ export const projectSnapshot = { lastUpdated: '2026-07-10', - technologiesSummary: 'including JavaScript, TypeScript, Shell, Astro, Makefile, and more.' + technologiesSummary: 'including Makefile, TypeScript, Go Template, JavaScript, Shell, and more.' };