Skip to content

Commit 62985a8

Browse files
hoverkraft-bot[bot]hoverkraft-bot[bot]
committed
docs: update actions and workflows documentation
[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent a42cfc5 commit 62985a8

File tree

2 files changed

+33
-25
lines changed

2 files changed

+33
-25
lines changed

‎.github/workflows/continuous-integration.md‎

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GitHub Reusable Workflow: Node.js Continuous Integration
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/18a765fa9c9c81cb07807356ca5cd6b7f081abeef5ae263581ba407bebfb6ac0/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Node.js Continuous Integration" />
6+
<img src="https://opengraph.githubassets.com/e309cae9c17a1139fbcaed62e9536b80cf64fd9d2c43359c5c5c666666bea49c/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Node.js Continuous Integration" />
77
</div>
88

99
---
@@ -54,7 +54,7 @@ permissions:
5454
id-token: write
5555
jobs:
5656
continuous-integration:
57-
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@acb0215bd991fe9aa6e8309fe0612620f40186f8 # copilot/update-workflow-for-docker-image
57+
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@4d7c1ed87c18493fc4c2dbae4dbde46cf251c9a7 # 0.16.1
5858
secrets:
5959
# Secrets to be used during the build step.
6060
# Must be a multi-line env formatted string.
@@ -64,6 +64,12 @@ jobs:
6464
# ```
6565
build-secrets: ""
6666
with:
67+
# JSON array of runner(s) to use.
68+
# See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.
69+
#
70+
# Default: `["ubuntu-latest"]`
71+
runs-on: '["ubuntu-latest"]'
72+
6773
# Build parameters. Must be a string or a JSON object.
6874
# For string, provide a list of commands to run during the build step, one per line.
6975
# For JSON object, provide the following properties:
@@ -132,26 +138,28 @@ jobs:
132138

133139
### Workflow Call Inputs
134140

135-
| **Input** | **Description** | **Required** | **Type** | **Default** |
136-
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ------------ |
137-
| **`build`** | Build parameters. Must be a string or a JSON object. | **false** | **string** | `build` |
138-
| | For string, provide a list of commands to run during the build step, one per line. | | | |
139-
| | For JSON object, provide the following properties: | | | |
140-
| | | | | |
141-
| | - `commands`: Array of commands to run during the build step. | | | |
142-
| | - `env`: Object of environment variables to set during the build step. | | | |
143-
| | - `artifact`: String or array of strings specifying paths to artifacts to upload after the build | | | |
144-
| | | | | |
145-
| | Example: | | | |
146-
| | <!-- textlint-disable --><pre lang="json">{&#13; "commands": [&#13; "build",&#13; "generate-artifacts"&#13; ],&#13; "env": {&#13; "CUSTOM_ENV_VAR": "value"&#13; },&#13; "artifact": [&#13; "dist/",&#13; "packages/package-a/build/"&#13; ]&#13;}</pre><!-- textlint-enable --> | | | |
147-
| **`checks`** | Optional flag to enable check steps. | **false** | **boolean** | `true` |
148-
| **`lint`** | Optional flag to enable linting. | **false** | **boolean** | `true` |
149-
| **`code-ql`** | Code QL analysis language. See <https://github.com/github/codeql-action>. | **false** | **string** | `typescript` |
150-
| **`dependency-review`** | Enable dependency review scan. See <https://github.com/actions/dependency-review-action>. | **false** | **boolean** | `true` |
151-
| **`test`** | Optional flag to enable test. | **false** | **boolean** | `true` |
152-
| **`coverage`** | Specify code coverage reporter. Supported values: `codecov`. | **false** | **string** | `codecov` |
153-
| **`working-directory`** | Working directory where the dependencies are installed. | **false** | **string** | `.` |
154-
| **`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** | - |
141+
| **Input** | **Description** | **Required** | **Type** | **Default** |
142+
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ------------------- |
143+
| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` |
144+
| | See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>. | | | |
145+
| **`build`** | Build parameters. Must be a string or a JSON object. | **false** | **string** | `build` |
146+
| | For string, provide a list of commands to run during the build step, one per line. | | | |
147+
| | For JSON object, provide the following properties: | | | |
148+
| | | | | |
149+
| | - `commands`: Array of commands to run during the build step. | | | |
150+
| | - `env`: Object of environment variables to set during the build step. | | | |
151+
| | - `artifact`: String or array of strings specifying paths to artifacts to upload after the build | | | |
152+
| | | | | |
153+
| | Example: | | | |
154+
| | <!-- textlint-disable --><pre lang="json">{&#13; "commands": [&#13; "build",&#13; "generate-artifacts"&#13; ],&#13; "env": {&#13; "CUSTOM_ENV_VAR": "value"&#13; },&#13; "artifact": [&#13; "dist/",&#13; "packages/package-a/build/"&#13; ]&#13;}</pre><!-- textlint-enable --> | | | |
155+
| **`checks`** | Optional flag to enable check steps. | **false** | **boolean** | `true` |
156+
| **`lint`** | Optional flag to enable linting. | **false** | **boolean** | `true` |
157+
| **`code-ql`** | Code QL analysis language. See <https://github.com/github/codeql-action>. | **false** | **string** | `typescript` |
158+
| **`dependency-review`** | Enable dependency review scan. See <https://github.com/actions/dependency-review-action>. | **false** | **boolean** | `true` |
159+
| **`test`** | Optional flag to enable test. | **false** | **boolean** | `true` |
160+
| **`coverage`** | Specify code coverage reporter. Supported values: `codecov`. | **false** | **string** | `codecov` |
161+
| **`working-directory`** | Working directory where the dependencies are installed. | **false** | **string** | `.` |
162+
| **`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** | - |
155163

156164
<!-- inputs:end -->
157165

@@ -188,7 +196,7 @@ on:
188196
189197
jobs:
190198
continuous-integration:
191-
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@acb0215bd991fe9aa6e8309fe0612620f40186f8 # copilot/update-workflow-for-docker-image
199+
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@4d7c1ed87c18493fc4c2dbae4dbde46cf251c9a7 # 0.16.1
192200
permissions:
193201
id-token: write
194202
security-events: write
@@ -254,7 +262,7 @@ jobs:
254262
# Run CI checks inside the Docker container
255263
continuous-integration:
256264
needs: build-image
257-
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@acb0215bd991fe9aa6e8309fe0612620f40186f8 # copilot/update-workflow-for-docker-image
265+
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@4d7c1ed87c18493fc4c2dbae4dbde46cf251c9a7 # 0.16.1
258266
permissions:
259267
id-token: write
260268
security-events: write

‎actions/get-package-manager/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItcGFja2FnZSIgY29sb3I9ImdyYXktZGFyayI+PGxpbmUgeDE9IjE2LjUiIHkxPSI5LjQiIHgyPSI3LjUiIHkyPSI0LjIxIj48L2xpbmU+PHBhdGggZD0iTTIxIDE2VjhhMiAyIDAgMCAwLTEtMS43M2wtNy00YTIgMiAwIDAgMC0yIDBsLTcgNEEyIDIgMCAwIDAgMyA4djhhMiAyIDAgMCAwIDEgMS43M2w3IDRhMiAyIDAgMCAwIDIgMGw3LTRBMiAyIDAgMCAwIDIxIDE2eiI+PC9wYXRoPjxwb2x5bGluZSBwb2ludHM9IjMuMjcgNi45NiAxMiAxMi4wMSAyMC43MyA2Ljk2Ij48L3BvbHlsaW5lPjxsaW5lIHgxPSIxMiIgeTE9IjIyLjA4IiB4Mj0iMTIiIHkyPSIxMiI+PC9saW5lPjwvc3ZnPg==) GitHub Action: Get package manager
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/0117dcf638f02d4da90af545ea1cae44cc8215860dbd273d47e78d65b56a6cfa/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Get package manager" />
6+
<img src="https://opengraph.githubassets.com/e309cae9c17a1139fbcaed62e9536b80cf64fd9d2c43359c5c5c666666bea49c/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Get package manager" />
77
</div>
88

99
---

0 commit comments

Comments
 (0)