diff --git a/.ghadocs.json b/.ghadocs.json deleted file mode 100644 index 140f4e1..0000000 --- a/.ghadocs.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "paths": { - "action": "action.yml", - "readme": "README.md" - }, - "show_logo": true, - "versioning": { - "enabled": true, - "override": "", - "prefix": "v", - "branch": "main" - }, - "owner": "hoverkraft-tech", - "repo": "ci-gitHub-nodejs", - "title_prefix": "GitHub Action: ", - "prettier": true -} diff --git a/.github/workflows/__main-ci.yml b/.github/workflows/__main-ci.yml index 4d12d77..c06896a 100644 --- a/.github/workflows/__main-ci.yml +++ b/.github/workflows/__main-ci.yml @@ -32,7 +32,7 @@ jobs: release: needs: ci if: github.event_name != 'schedule' - uses: hoverkraft-tech/ci-github-publish/.github/workflows/release-actions.yml@00adc3757296add499b60fd72a124b06974a100e # 0.10.1 + uses: hoverkraft-tech/ci-github-publish/.github/workflows/release-actions.yml@42d50a3461a177557ca3f83b1d927d7c0783c894 # 0.11.2 with: update-all: ${{ (github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')) || github.event_name == 'workflow_dispatch' }} github-app-id: ${{ vars.CI_BOT_APP_ID }} diff --git a/.github/workflows/continuous-integration.md b/.github/workflows/continuous-integration.md index e93c15c..12d6fcf 100644 --- a/.github/workflows/continuous-integration.md +++ b/.github/workflows/continuous-integration.md @@ -1,9 +1,27 @@ - + # GitHub Reusable Workflow: Node.js Continuous Integration - - +
+ NodeJS Continuous Integration +
+ +--- + + + + + +[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-nodejs)](https://github.com/hoverkraft-tech/ci-github-nodejs/releases) +[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-nodejs)](http://choosealicense.com/licenses/mit/) +[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) + + + + + +## Overview Workflow to performs continuous integration steps agains a Node.js project: @@ -12,68 +30,99 @@ Workflow to performs continuous integration steps agains a Node.js project: - Build - Test - - - - +### Permissions -```yaml -name: Nodejs Continuous Integration +- **`contents`**: `read` +- **`security-events`**: `write` +- **`id-token`**: `write` + + + + +## Usage + +```yaml +name: NodeJS Continuous Integration on: - merge_group: push: - branches: [main] - pull_request: - branches: [main] - + branches: + - main permissions: contents: read security-events: write - # FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659 id-token: write - jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@0.14.1 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1 + with: + # Build parameters. Must be a string or a json object. + # Default: `build` + build: build + + # Optional flag to enable check steps. + # Default: `true` + checks: true + + # Optional flag to enable linting. + # Default: `true` + lint: true + + # Code QL analysis language. See . + # Default: `typescript` + code-ql: typescript + + # Enable dependency review scan. See . + # Default: `true` + dependency-review: true + + # Optional flag to enable test. + # Default: `true` + test: true + + # Specifify code coverage reporter. Supported values: 'codecov'. + # Default: `codecov` + coverage: codecov + + # Working directory where the dependencies are installed. + # Default: `.` + working-directory: . ``` - - - - + + + ## Inputs -| **Input** | **Description** | **Type** | **Default** | **Required** | -| ------------------------- | ------------------------------------------------------------------------- | -------------------- | ------------------------- | ------------ | -| **build** | Build parameters. Must be a string or a JSON array of strings or object. | string | build | **false** | -| **checks** | Optional flag to enable check steps. | boolean | true | **false** | -| **code-ql** | Code QL analysis language. See . | string | `typescript` | **false** | -| **lint** | Optional flag to enable linting. | boolean | true | **false** | -| **test** | Optional flag to enable test. | boolean | true | **false** | -| **coverage** | Specifify code coverage reporter. Supported values: `codecov`. | string | `codecov` | **false** | +### Workflow Call Inputs + +| **Input** | **Description** | **Required** | **Type** | **Default** | +| ----------------------- | ----------------------------------------------------------------------------------------- | ------------ | ----------- | ------------ | +| **`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` | +| **`working-directory`** | Working directory where the dependencies are installed. | **false** | **string** | `.` | -### `build` input parameters + -When `build` is a JSON object, the following parameters are supported: + + -| **Input** | **Description** | **Type** | **Default** | **Required** | -| ---------- | -------------------------------------------------------------------------------------------------------- | ------------------ | ----------- | ------------ | -| `commands` | Build command(s). | string[] | `["build"]` | **false** | -| `artifact` | Build artifact (name will be `build`) to be uploaded. (See ) | string or string[] | `` | **false** | + + - - - - + ## Examples ### Continuous Integration, build and publish ```yaml - name: Continuous Integration - Build and Publish name: Nodejs Continuous Integration @@ -84,7 +133,7 @@ on: jobs: continuous-integration: - uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@0.14.1 + uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1 permissions: id-token: write security-events: write @@ -119,4 +168,37 @@ jobs: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} ``` - + + + + +## Contributing + +Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) for more details. + + + + + + + + +## License + +This project is licensed under the MIT License. + +SPDX-License-Identifier: MIT + +Copyright © 2025 hoverkraft-tech + +For more details, see the [license](http://choosealicense.com/licenses/mit/). + + + + + +--- + +This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor). + + diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index a0ad44d..4810d18 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -1,6 +1,5 @@ -# NodeJS Continuous Integration -# ========================== # Workflow to performs continuous integration steps agains a NodeJs project: +# # - CodeQL analysis # - Linting # - Build @@ -67,10 +66,10 @@ jobs: runs-on: "ubuntu-latest" steps: - uses: hoverkraft-tech/ci-github-common/actions/checkout@1c379f7f6e0fc850fe5a7111f74d54e159b4dcd2 # 0.26.0 - - uses: github/codeql-action/init@64d10c13136e1c5bce3e5fbde8d4906eeaafc885 # v3.30.6 + - uses: github/codeql-action/init@e296a935590eb16afc0c0108289f68c87e2a89a5 # v4.30.7 with: languages: ${{ inputs.code-ql }} - - uses: github/codeql-action/analyze@64d10c13136e1c5bce3e5fbde8d4906eeaafc885 # v3.30.6 + - uses: github/codeql-action/analyze@e296a935590eb16afc0c0108289f68c87e2a89a5 # v4.30.7 dependency-review: name: 🛡️ Dependency Review diff --git a/Dockerfile b/Dockerfile index 0456d58..162a729 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,6 @@ -#checkov:skip=CKV_DOCKER_2: required -FROM ghcr.io/super-linter/super-linter:slim-v8 +FROM ghcr.io/super-linter/super-linter:slim-v8.0.0 +HEALTHCHECK --interval=5m --timeout=10s --start-period=30s --retries=3 CMD ["/bin/sh","-c","test -d /github/home"] ARG UID=1000 ARG GID=1000 RUN chown -R ${UID}:${GID} /github/home @@ -9,4 +9,4 @@ USER ${UID}:${GID} ENV RUN_LOCAL=true ENV USE_FIND_ALGORITHM=true ENV LOG_LEVEL=WARN -ENV LOG_FILE="/github/home/logs" \ No newline at end of file +ENV LOG_FILE="/github/home/logs" diff --git a/actions/dependencies-cache/README.md b/actions/dependencies-cache/README.md index 6052dc5..aaa4ee8 100644 --- a/actions/dependencies-cache/README.md +++ b/actions/dependencies-cache/README.md @@ -1,40 +1,108 @@ - + -# branding<icon:archive color:gray-dark> GitHub Action: Dependencies cache +# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItYXJjaGl2ZSIgY29sb3I9ImdyYXktZGFyayI+PHBvbHlsaW5lIHBvaW50cz0iMjEgOCAyMSAyMSAzIDIxIDMgOCI+PC9wb2x5bGluZT48cmVjdCB4PSIxIiB5PSIzIiB3aWR0aD0iMjIiIGhlaWdodD0iNSI+PC9yZWN0PjxsaW5lIHgxPSIxMCIgeTE9IjEyIiB4Mj0iMTQiIHkyPSIxMiI+PC9saW5lPjwvc3ZnPg==) GitHub Action: Dependencies cache - - +
+ Dependencies cache +
+ +--- + + + + + +[![Marketplace](https://img.shields.io/badge/Marketplace-dependencies--cache-blue?logo=github-actions)](https://github.com/marketplace/actions/dependencies-cache) +[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-nodejs)](https://github.com/hoverkraft-tech/ci-github-nodejs/releases) +[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-nodejs)](http://choosealicense.com/licenses/mit/) +[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) + + + + + +## Overview Action to setup dependencies cache managment. - - - - + + + + +## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs@0.14.1 +- uses: hoverkraft-tech/ci-github-nodejs/actions/dependencies-cache@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1 with: - # Description: List of dependencies for which the cache should be managed. - # + # List of dependencies for which the cache should be managed. + # This input is required. dependencies: "" - # Description: Working directory where the dependencies are installed. - # - # Default: . - working-directory: "" + # Working directory where the dependencies are installed. + # Default: `.` + working-directory: . ``` - - + + + + +## Inputs + +| **Input** | **Description** | **Required** | **Default** | +| ----------------------- | ----------------------------------------------------------- | ------------ | ----------- | +| **`dependencies`** | List of dependencies for which the cache should be managed. | **true** | - | +| **`working-directory`** | Working directory where the dependencies are installed. | **false** | `.` | + + + + + + + + + + + + + + + + +## Contributing + +Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) for more details. + + + + + + + + +## License + +This project is licensed under the MIT License. + +SPDX-License-Identifier: MIT + +Copyright © 2025 Hoverkraft + +For more details, see the [license](http://choosealicense.com/licenses/mit/). + + + + + +--- + +This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor). -| **Input** | **Description** | **Default** | **Required** | -| ------------------------------ | ----------------------------------------------------------- | -------------- | ------------ | -| dependencies | List of dependencies for which the cache should be managed. | | **true** | -| working-directory | Working directory where the dependencies are installed. | . | **false** | + - - - - - + diff --git a/actions/get-package-manager/README.md b/actions/get-package-manager/README.md index 7d9c6b0..1a51164 100644 --- a/actions/get-package-manager/README.md +++ b/actions/get-package-manager/README.md @@ -1,43 +1,113 @@ - + -# branding<icon:package color:gray-dark> GitHub Action: Get package manager +# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItcGFja2FnZSIgY29sb3I9ImdyYXktZGFyayI+PGxpbmUgeDE9IjE2LjUiIHkxPSI5LjQiIHgyPSI3LjUiIHkyPSI0LjIxIj48L2xpbmU+PHBhdGggZD0iTTIxIDE2VjhhMiAyIDAgMCAwLTEtMS43M2wtNy00YTIgMiAwIDAgMC0yIDBsLTcgNEEyIDIgMCAwIDAgMyA4djhhMiAyIDAgMCAwIDEgMS43M2w3IDRhMiAyIDAgMCAwIDIgMGw3LTRBMiAyIDAgMCAwIDIxIDE2eiI+PC9wYXRoPjxwb2x5bGluZSBwb2ludHM9IjMuMjcgNi45NiAxMiAxMi4wMSAyMC43MyA2Ljk2Ij48L3BvbHlsaW5lPjxsaW5lIHgxPSIxMiIgeTE9IjIyLjA4IiB4Mj0iMTIiIHkyPSIxMiI+PC9saW5lPjwvc3ZnPg==) GitHub Action: Get package manager - - +
+ Get package manager +
+ +--- + + + + + +[![Marketplace](https://img.shields.io/badge/Marketplace-get--package--manager-blue?logo=github-actions)](https://github.com/marketplace/actions/get-package-manager) +[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-nodejs)](https://github.com/hoverkraft-tech/ci-github-nodejs/releases) +[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-nodejs)](http://choosealicense.com/licenses/mit/) +[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) + + + + + +## Overview Action to detect the package manager used. Supports Yarn and npm - - - - + + + + +## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs@0.14.1 +- uses: hoverkraft-tech/ci-github-nodejs/actions/get-package-manager@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1 with: - # Description: Working directory where the dependencies are installed. - # - # Default: . - working-directory: "" + # Working directory where the dependencies are installed. + # Default: `.` + working-directory: . ``` - - + + + + +## Inputs + +| **Input** | **Description** | **Required** | **Default** | +| ----------------------- | ------------------------------------------------------- | ------------ | ----------- | +| **`working-directory`** | Working directory where the dependencies are installed. | **false** | `.` | + + + + + + + + +## Outputs + +| **Output** | **Description** | +| --------------------------- | ----------------------------------------------------- | +| **`package-manager`** | The package manager used. | +| **`cache-dependency-path`** | The path to the dependency file for cache management. | +| **`install-command`** | The command to install dependencies. | +| **`run-script-command`** | The command to run a script in the package.json file. | + + + + + + + + + + +## Contributing + +Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) for more details. + + + + + + + + +## License + +This project is licensed under the MIT License. + +SPDX-License-Identifier: MIT + +Copyright © 2025 Hoverkraft + +For more details, see the [license](http://choosealicense.com/licenses/mit/). + + + + -| **Input** | **Description** | **Default** | **Required** | -| ------------------------------ | ------------------------------------------------------- | -------------- | ------------ | -| working-directory | Working directory where the dependencies are installed. | . | **false** | +--- - - +This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor). -| **Output** | **Description** | -| ---------------------------------- | ----------------------------------------------------- | -| package-manager | The package manager used. | -| cache-dependency-path | The path to the dependency file for cache management. | -| install-command | The command to install dependencies. | -| run-script-command | The command to run a script in the package.json file. | + - - - + diff --git a/actions/has-installed-dependencies/README.md b/actions/has-installed-dependencies/README.md index d689cd7..a1052b2 100644 --- a/actions/has-installed-dependencies/README.md +++ b/actions/has-installed-dependencies/README.md @@ -1,45 +1,115 @@ - + -# branding<icon:settings color:gray-dark> GitHub Action: Has installed dependencies +# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItc2V0dGluZ3MiIGNvbG9yPSJncmF5LWRhcmsiPjxjaXJjbGUgY3g9IjEyIiBjeT0iMTIiIHI9IjMiPjwvY2lyY2xlPjxwYXRoIGQ9Ik0xOS40IDE1YTEuNjUgMS42NSAwIDAgMCAuMzMgMS44MmwuMDYuMDZhMiAyIDAgMCAxIDAgMi44MyAyIDIgMCAwIDEtMi44MyAwbC0uMDYtLjA2YTEuNjUgMS42NSAwIDAgMC0xLjgyLS4zMyAxLjY1IDEuNjUgMCAwIDAtMSAxLjUxVjIxYTIgMiAwIDAgMS0yIDIgMiAyIDAgMCAxLTItMnYtLjA5QTEuNjUgMS42NSAwIDAgMCA5IDE5LjRhMS42NSAxLjY1IDAgMCAwLTEuODIuMzNsLS4wNi4wNmEyIDIgMCAwIDEtMi44MyAwIDIgMiAwIDAgMSAwLTIuODNsLjA2LS4wNmExLjY1IDEuNjUgMCAwIDAgLjMzLTEuODIgMS42NSAxLjY1IDAgMCAwLTEuNTEtMUgzYTIgMiAwIDAgMS0yLTIgMiAyIDAgMCAxIDItMmguMDlBMS42NSAxLjY1IDAgMCAwIDQuNiA5YTEuNjUgMS42NSAwIDAgMC0uMzMtMS44MmwtLjA2LS4wNmEyIDIgMCAwIDEgMC0yLjgzIDIgMiAwIDAgMSAyLjgzIDBsLjA2LjA2YTEuNjUgMS42NSAwIDAgMCAxLjgyLjMzSDlhMS42NSAxLjY1IDAgMCAwIDEtMS41MVYzYTIgMiAwIDAgMSAyLTIgMiAyIDAgMCAxIDIgMnYuMDlhMS42NSAxLjY1IDAgMCAwIDEgMS41MSAxLjY1IDEuNjUgMCAwIDAgMS44Mi0uMzNsLjA2LS4wNmEyIDIgMCAwIDEgMi44MyAwIDIgMiAwIDAgMSAwIDIuODNsLS4wNi4wNmExLjY1IDEuNjUgMCAwIDAtLjMzIDEuODJWOWExLjY1IDEuNjUgMCAwIDAgMS41MSAxSDIxYTIgMiAwIDAgMSAyIDIgMiAyIDAgMCAxLTIgMmgtLjA5YTEuNjUgMS42NSAwIDAgMC0xLjUxIDF6Ij48L3BhdGg+PC9zdmc+) GitHub Action: Has installed dependencies - - +
+ Has installed dependencies +
+ +--- + + + + + +[![Marketplace](https://img.shields.io/badge/Marketplace-has--installed--dependencies-blue?logo=github-actions)](https://github.com/marketplace/actions/has-installed-dependencies) +[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-nodejs)](https://github.com/hoverkraft-tech/ci-github-nodejs/releases) +[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-nodejs)](http://choosealicense.com/licenses/mit/) +[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) + + + + + +## Overview Action to check if dependencies have been installed according to the package manager used. - - - - + + + + +## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs@0.14.1 +- uses: hoverkraft-tech/ci-github-nodejs/actions/has-installed-dependencies@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1 with: - # Description: The dependencies to check. - # + # The dependencies to check. + # This input is required. dependencies: "" - # Description: Working directory where the dependencies are installed. - # - # Default: . - working-directory: "" + # Working directory where the dependencies are installed. + # Default: `.` + working-directory: . ``` - - + + + + +## Inputs + +| **Input** | **Description** | **Required** | **Default** | +| ----------------------- | ------------------------------------------------------- | ------------ | ----------- | +| **`dependencies`** | The dependencies to check. | **true** | - | +| **`working-directory`** | Working directory where the dependencies are installed. | **false** | `.` | + + + + + + + + +## Outputs + +| **Output** | **Description** | +| ---------------------------- | ----------------------------------------------------------------------------- | +| **`installed-dependencies`** | A map of dependencies and the status weither they have been installed or not. | + + + + + + + + + + +## Contributing + +Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) for more details. + + + + + + + + +## License + +This project is licensed under the MIT License. + +SPDX-License-Identifier: MIT + +Copyright © 2025 Hoverkraft + +For more details, see the [license](http://choosealicense.com/licenses/mit/). + + + + -| **Input** | **Description** | **Default** | **Required** | -| ------------------------------ | ------------------------------------------------------- | -------------- | ------------ | -| dependencies | The dependencies to check. | | **true** | -| working-directory | Working directory where the dependencies are installed. | . | **false** | +--- - - +This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor). -| **Output** | **Description** | -| ----------------------------------- | ----------------------------------------------------------------------------- | -| installed-dependencies | A map of dependencies and the status weither they have been installed or not. | + - - - + diff --git a/actions/setup-node/README.md b/actions/setup-node/README.md index 47f5d20..8ad7c78 100644 --- a/actions/setup-node/README.md +++ b/actions/setup-node/README.md @@ -1,46 +1,114 @@ - + -# branding<icon:settings color:gray-dark> GitHub Action: Setup Node.js +# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItc2V0dGluZ3MiIGNvbG9yPSJncmF5LWRhcmsiPjxjaXJjbGUgY3g9IjEyIiBjeT0iMTIiIHI9IjMiPjwvY2lyY2xlPjxwYXRoIGQ9Ik0xOS40IDE1YTEuNjUgMS42NSAwIDAgMCAuMzMgMS44MmwuMDYuMDZhMiAyIDAgMCAxIDAgMi44MyAyIDIgMCAwIDEtMi44MyAwbC0uMDYtLjA2YTEuNjUgMS42NSAwIDAgMC0xLjgyLS4zMyAxLjY1IDEuNjUgMCAwIDAtMSAxLjUxVjIxYTIgMiAwIDAgMS0yIDIgMiAyIDAgMCAxLTItMnYtLjA5QTEuNjUgMS42NSAwIDAgMCA5IDE5LjRhMS42NSAxLjY1IDAgMCAwLTEuODIuMzNsLS4wNi4wNmEyIDIgMCAwIDEtMi44MyAwIDIgMiAwIDAgMSAwLTIuODNsLjA2LS4wNmExLjY1IDEuNjUgMCAwIDAgLjMzLTEuODIgMS42NSAxLjY1IDAgMCAwLTEuNTEtMUgzYTIgMiAwIDAgMS0yLTIgMiAyIDAgMCAxIDItMmguMDlBMS42NSAxLjY1IDAgMCAwIDQuNiA5YTEuNjUgMS42NSAwIDAgMC0uMzMtMS44MmwtLjA2LS4wNmEyIDIgMCAwIDEgMC0yLjgzIDIgMiAwIDAgMSAyLjgzIDBsLjA2LjA2YTEuNjUgMS42NSAwIDAgMCAxLjgyLjMzSDlhMS42NSAxLjY1IDAgMCAwIDEtMS41MVYzYTIgMiAwIDAgMSAyLTIgMiAyIDAgMCAxIDIgMnYuMDlhMS42NSAxLjY1IDAgMCAwIDEgMS41MSAxLjY1IDEuNjUgMCAwIDAgMS44Mi0uMzNsLjA2LS4wNmEyIDIgMCAwIDEgMi44MyAwIDIgMiAwIDAgMSAwIDIuODNsLS4wNi4wNmExLjY1IDEuNjUgMCAwIDAtLjMzIDEuODJWOWExLjY1IDEuNjUgMCAwIDAgMS41MSAxSDIxYTIgMiAwIDAgMSAyIDIgMiAyIDAgMCAxLTIgMmgtLjA5YTEuNjUgMS42NSAwIDAgMC0xLjUxIDF6Ij48L3BhdGg+PC9zdmc+) GitHub Action: Setup Node.js - - +
+ Setup Node.js +
+ +--- + + + + + +[![Marketplace](https://img.shields.io/badge/Marketplace-setup--node.js-blue?logo=github-actions)](https://github.com/marketplace/actions/setup-node.js) +[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-nodejs)](https://github.com/hoverkraft-tech/ci-github-nodejs/releases) +[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-nodejs)](http://choosealicense.com/licenses/mit/) +[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) + + + + + +## Overview Action to setup Node.js and install dependencies according to the package manager used. - - - - + + + + +## Usage ```yaml -- uses: hoverkraft-tech/ci-github-nodejs@0.14.1 +- uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1 with: - # Description: List of dependencies for which the cache should be managed - # - # Default: + # List of dependencies for which the cache should be managed dependencies-cache: "" - # Description: Working directory where the dependencies are installed. - # - # Default: . - working-directory: "" + # Working directory where the dependencies are installed. + # Default: `.` + working-directory: . ``` - - + + + + +## 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** | `.` | + + + + + + + + +## Outputs + +| **Output** | **Description** | +| ------------------------ | ---------------------------------------------------- | +| **`run-script-command`** | The command to run a script in the package.json file | + + + + + + + + + + +## Contributing + +Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) for more details. + + + + + + + + +## License + +This project is licensed under the MIT License. + +SPDX-License-Identifier: MIT + +Copyright © 2025 Hoverkraft + +For more details, see the [license](http://choosealicense.com/licenses/mit/). + + + + -| **Input** | **Description** | **Default** | **Required** | -| ------------------------------- | ---------------------------------------------------------- | -------------- | ------------ | -| dependencies-cache | List of dependencies for which the cache should be managed | | **false** | -| working-directory | Working directory where the dependencies are installed. | . | **false** | +--- - - +This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor). -| **Output** | **Description** | -| ------------------------------- | ---------------------------------------------------- | -| run-script-command | The command to run a script in the package.json file | + - - - + diff --git a/actions/setup-node/action.yml b/actions/setup-node/action.yml index 09bb08f..21706bc 100644 --- a/actions/setup-node/action.yml +++ b/actions/setup-node/action.yml @@ -61,7 +61,7 @@ runs: fi echo "pnpm-version=latest" >> "$GITHUB_OUTPUT" - - uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4.1.0 + - uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4.2.0 if: steps.get-package-manager.outputs.package-manager == 'pnpm' with: version: ${{ steps.get-pnpm-version.outputs.pnpm-version }}