Skip to content

Commit 4e5c40b

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 32a69b7 commit 4e5c40b

File tree

8 files changed

+69
-56
lines changed

8 files changed

+69
-56
lines changed

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

Lines changed: 28 additions & 15 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/5bff83a351121c577bee39e10ea7d6774aba5d0d7d7b114ba0e8b79d48d09267/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Node.js Continuous Integration" />
6+
<img src="https://opengraph.githubassets.com/50237226ce5d3230f19bbf31d04efd98f21cb2150e9ae4acd09a498440ecde82/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Node.js Continuous Integration" />
77
</div>
88

99
---
@@ -34,6 +34,7 @@ Workflow to performs continuous integration steps agains a Node.js project:
3434

3535
- **`contents`**: `read`
3636
- **`id-token`**: `write`
37+
- **`pull-requests`**: `write`
3738
- **`security-events`**: `write`
3839

3940
<!-- overview:end -->
@@ -51,7 +52,7 @@ on:
5152
permissions: {}
5253
jobs:
5354
continuous-integration:
54-
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@23af54bc615d657aa9c13c472ae701445c1811a6 # 0.17.1
55+
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0
5556
secrets:
5657
# Secrets to be used during the build step.
5758
# Must be a multi-line env formatted string.
@@ -99,9 +100,12 @@ jobs:
99100
# Default: `true`
100101
checks: true
101102

102-
# Optional flag to enable linting.
103+
# Whether to enable linting.
104+
# Set to `null` or empty to disable.
105+
# Accepts a JSON object for lint options. See [lint action](../actions/lint/README.md).
106+
#
103107
# Default: `true`
104-
lint: true
108+
lint: "true"
105109

106110
# Code QL analysis language. See <https://github.com/github/codeql-action>.
107111
# Default: `typescript`
@@ -111,13 +115,12 @@ jobs:
111115
# Default: `true`
112116
dependency-review: true
113117

114-
# Optional flag to enable test.
118+
# Whether to enable testing.
119+
# Set to `null` or empty to disable.
120+
# Accepts a JSON object for test options. See [test action](../actions/test/README.md).
121+
#
115122
# Default: `true`
116-
test: true
117-
118-
# Specify code coverage reporter. Supported values: `codecov`.
119-
# Default: `codecov`
120-
coverage: codecov
123+
test: "true"
121124

122125
# Working directory where the dependencies are installed.
123126
# Default: `.`
@@ -150,11 +153,14 @@ jobs:
150153
| | Example: | | | |
151154
| | <!-- 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 --> | | | |
152155
| **`checks`** | Optional flag to enable check steps. | **false** | **boolean** | `true` |
153-
| **`lint`** | Optional flag to enable linting. | **false** | **boolean** | `true` |
156+
| **`lint`** | Whether to enable linting. | **false** | **string** | `true` |
157+
| | Set to `null` or empty to disable. | | | |
158+
| | Accepts a JSON object for lint options. See [lint action](../actions/lint/README.md). | | | |
154159
| **`code-ql`** | Code QL analysis language. See <https://github.com/github/codeql-action>. | **false** | **string** | `typescript` |
155160
| **`dependency-review`** | Enable dependency review scan. See <https://github.com/actions/dependency-review-action>. | **false** | **boolean** | `true` |
156-
| **`test`** | Optional flag to enable test. | **false** | **boolean** | `true` |
157-
| **`coverage`** | Specify code coverage reporter. Supported values: `codecov`. | **false** | **string** | `codecov` |
161+
| **`test`** | Whether to enable testing. | **false** | **string** | `true` |
162+
| | Set to `null` or empty to disable. | | | |
163+
| | Accepts a JSON object for test options. See [test action](../actions/test/README.md). | | | |
158164
| **`working-directory`** | Working directory where the dependencies are installed. | **false** | **string** | `.` |
159165
| **`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** | - |
160166

@@ -174,6 +180,13 @@ jobs:
174180
<!-- secrets:end -->
175181

176182
<!-- outputs:start -->
183+
184+
## Outputs
185+
186+
| **Output** | **Description** |
187+
| ----------------------- | --------------------------------------------------------- |
188+
| **`build-artifact-id`** | ID of the build artifact) uploaded during the build step. |
189+
177190
<!-- outputs:end -->
178191

179192
<!-- examples:start -->
@@ -193,7 +206,7 @@ on:
193206
194207
jobs:
195208
continuous-integration:
196-
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@23af54bc615d657aa9c13c472ae701445c1811a6 # 0.17.1
209+
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0
197210
permissions:
198211
id-token: write
199212
security-events: write
@@ -259,7 +272,7 @@ jobs:
259272
# Run CI checks inside the Docker container
260273
continuous-integration:
261274
needs: build-image
262-
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@23af54bc615d657aa9c13c472ae701445c1811a6 # 0.17.1
275+
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0
263276
permissions:
264277
id-token: write
265278
security-events: write

‎actions/build/README.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItcGFja2FnZSIgY29sb3I9ImJsdWUiPjxsaW5lIHgxPSIxNi41IiB5MT0iOS40IiB4Mj0iNy41IiB5Mj0iNC4yMSI+PC9saW5lPjxwYXRoIGQ9Ik0yMSAxNlY4YTIgMiAwIDAgMC0xLTEuNzNsLTctNGEyIDIgMCAwIDAtMiAwbC03IDRBMiAyIDAgMCAwIDMgOHY4YTIgMiAwIDAgMCAxIDEuNzNsNyA0YTIgMiAwIDAgMCAyIDBsNy00QTIgMiAwIDAgMCAyMSAxNnoiPjwvcGF0aD48cG9seWxpbmUgcG9pbnRzPSIzLjI3IDYuOTYgMTIgMTIuMDEgMjAuNzMgNi45NiI+PC9wb2x5bGluZT48bGluZSB4MT0iMTIiIHkxPSIyMi4wOCIgeDI9IjEyIiB5Mj0iMTIiPjwvbGluZT48L3N2Zz4=) GitHub Action: Build
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/b83a39d0a270998cbae0974683a11eba4481aa44bbb4abbc39522474251c5b0a/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Build" />
6+
<img src="https://opengraph.githubassets.com/50237226ce5d3230f19bbf31d04efd98f21cb2150e9ae4acd09a498440ecde82/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Build" />
77
</div>
88

99
---
@@ -30,7 +30,7 @@ Action to build Node.js projects with support for custom commands, environment v
3030
## Usage
3131

3232
````yaml
33-
- uses: hoverkraft-tech/ci-github-nodejs/actions/build@dde8f0c67661ed66da8871a9fb104d36e146d644 # copilot/refactor-ci-actions-lint-test
33+
- uses: hoverkraft-tech/ci-github-nodejs/actions/build@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0
3434
with:
3535
# Working directory where the build commands are executed.
3636
# Can be absolute or relative to the repository root.
@@ -53,8 +53,8 @@ Action to build Node.js projects with support for custom commands, environment v
5353
# Multi-line string of secrets in env format (KEY=VALUE).
5454
# Example:
5555
# ```
56-
# SECRET_KEY=${{ secrets.SECRET_KEY }}
57-
# API_TOKEN=${{ secrets.API_TOKEN }}
56+
# SECRET_KEY=$\{{ secrets.SECRET_KEY }}
57+
# API_TOKEN=$\{{ secrets.API_TOKEN }}
5858
# ```
5959
build-secrets: ""
6060

@@ -72,20 +72,20 @@ Action to build Node.js projects with support for custom commands, environment v
7272

7373
## Inputs
7474

75-
| **Input** | **Description** | **Required** | **Default** |
76-
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- |
77-
| **`working-directory`** | Working directory where the build commands are executed. | **false** | `.` |
78-
| | Can be absolute or relative to the repository root. | | |
79-
| **`build-commands`** | List of build commands to execute, one per line. | **true** | - |
80-
| | These are npm/pnpm/Yarn script names (e.g., "build", "compile"). | | |
81-
| **`build-env`** | JSON object of environment variables to set during the build. | **false** | `\{}` |
82-
| | Example: {"NODE_ENV": "production", "API_URL": "<https://api.example.com"}> | | |
83-
| **`build-secrets`** | Multi-line string of secrets in env format (KEY=VALUE). | **false** | - |
84-
| | Example: | | |
85-
| | <!-- textlint-disable --><pre>SECRET_KEY=${{ secrets.SECRET_KEY }}&#13;API_TOKEN=${{ secrets.API_TOKEN }}</pre><!-- textlint-enable --> | | |
86-
| **`build-artifact`** | JSON object specifying artifact upload configuration. | **false** | - |
87-
| | Format: {"name": "artifact-name", "paths": "path1\npath2"} | | |
88-
| **`container`** | Whether running in container mode (skips checkout and node setup) | **false** | `false` |
75+
| **Input** | **Description** | **Required** | **Default** |
76+
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- |
77+
| **`working-directory`** | Working directory where the build commands are executed. | **false** | `.` |
78+
| | Can be absolute or relative to the repository root. | | |
79+
| **`build-commands`** | List of build commands to execute, one per line. | **true** | - |
80+
| | These are npm/pnpm/yarn script names (e.g., "build", "compile"). | | |
81+
| **`build-env`** | JSON object of environment variables to set during the build. | **false** | `\{}` |
82+
| | Example: {"NODE_ENV": "production", "API_URL": "<https://api.example.com"}> | | |
83+
| **`build-secrets`** | Multi-line string of secrets in env format (KEY=VALUE). | **false** | - |
84+
| | Example: | | |
85+
| | <!-- textlint-disable --><pre>SECRET_KEY=$\{{ secrets.SECRET_KEY }}&#13;API_TOKEN=$\{{ secrets.API_TOKEN }}</pre><!-- textlint-enable --> | | |
86+
| **`build-artifact`** | JSON object specifying artifact upload configuration. | **false** | - |
87+
| | Format: {"name": "artifact-name", "paths": "path1\npath2"} | | |
88+
| **`container`** | Whether running in container mode (skips checkout and node setup) | **false** | `false` |
8989

9090
<!-- inputs:end -->
9191
<!-- secrets:start -->

‎actions/dependencies-cache/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!-- header:start -->
22

3-
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItYXJjaGl2ZSIgY29sb3I9ImdyYXktZGFyayI+PHBvbHlsaW5lIHBvaW50cz0iMjEgOCAyMSAyMSAzIDIxIDMgOCI+PC9wb2x5bGluZT48cmVjdCB4PSIxIiB5PSIzIiB3aWR0aD0iMjIiIGhlaWdodD0iNSI+PC9yZWN0PjxsaW5lIHgxPSIxMCIgeTE9IjEyIiB4Mj0iMTQiIHkyPSIxMiI+PC9saW5lPjwvc3ZnPg==) GitHub Action: Dependencies cache
3+
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItYXJjaGl2ZSIgY29sb3I9ImJsdWUiPjxwb2x5bGluZSBwb2ludHM9IjIxIDggMjEgMjEgMyAyMSAzIDgiPjwvcG9seWxpbmU+PHJlY3QgeD0iMSIgeT0iMyIgd2lkdGg9IjIyIiBoZWlnaHQ9IjUiPjwvcmVjdD48bGluZSB4MT0iMTAiIHkxPSIxMiIgeDI9IjE0IiB5Mj0iMTIiPjwvbGluZT48L3N2Zz4=) GitHub Action: Dependencies cache
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/5bff83a351121c577bee39e10ea7d6774aba5d0d7d7b114ba0e8b79d48d09267/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Dependencies cache" />
6+
<img src="https://opengraph.githubassets.com/50237226ce5d3230f19bbf31d04efd98f21cb2150e9ae4acd09a498440ecde82/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Dependencies cache" />
77
</div>
88

99
---
@@ -33,7 +33,7 @@ Action to setup dependencies cache managment.
3333
## Usage
3434

3535
```yaml
36-
- uses: hoverkraft-tech/ci-github-nodejs/actions/dependencies-cache@23af54bc615d657aa9c13c472ae701445c1811a6 # 0.17.1
36+
- uses: hoverkraft-tech/ci-github-nodejs/actions/dependencies-cache@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0
3737
with:
3838
# List of dependencies for which the cache should be managed.
3939
# This input is required.
@@ -92,7 +92,7 @@ This project is licensed under the MIT License.
9292

9393
SPDX-License-Identifier: MIT
9494

95-
Copyright © 2025 Hoverkraft
95+
Copyright © 2025 hoverkraft
9696

9797
For more details, see the [license](http://choosealicense.com/licenses/mit/).
9898

0 commit comments

Comments
 (0)