Skip to content

Commit 421cbe6

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 c02a28b commit 421cbe6

5 files changed

Lines changed: 28 additions & 16 deletions

File tree

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

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

99
---
@@ -43,7 +43,7 @@ Workflow to performs continuous integration steps agains a Node.js project:
4343
## Usage
4444

4545
```yaml
46-
name: NodeJS Continuous Integration
46+
name: Node.js Continuous Integration
4747
on:
4848
push:
4949
branches:
@@ -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@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1
57+
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@4b87508052fc8b08a44a5d2d7d5f0636deb6ea3e # 0.15.0
5858
with:
5959
# Build parameters. Must be a string or a json object.
6060
# Default: `build`
@@ -80,7 +80,7 @@ jobs:
8080
# Default: `true`
8181
test: true
8282

83-
# Specifify code coverage reporter. Supported values: 'codecov'.
83+
# Specifify code coverage reporter. Supported values: `codecov`.
8484
# Default: `codecov`
8585
coverage: codecov
8686

@@ -99,13 +99,13 @@ jobs:
9999
100100
| **Input** | **Description** | **Required** | **Type** | **Default** |
101101
| ----------------------- | ----------------------------------------------------------------------------------------- | ------------ | ----------- | ------------ |
102-
| **`build`** | Build parameters. Must be a string or a JSON object. | **false** | **string** | `build` |
102+
| **`build`** | Build parameters. Must be a string or a json object. | **false** | **string** | `build` |
103103
| **`checks`** | Optional flag to enable check steps. | **false** | **boolean** | `true` |
104104
| **`lint`** | Optional flag to enable linting. | **false** | **boolean** | `true` |
105105
| **`code-ql`** | Code QL analysis language. See <https://github.com/github/codeql-action>. | **false** | **string** | `typescript` |
106106
| **`dependency-review`** | Enable dependency review scan. See <https://github.com/actions/dependency-review-action>. | **false** | **boolean** | `true` |
107107
| **`test`** | Optional flag to enable test. | **false** | **boolean** | `true` |
108-
| **`coverage`** | Specifify code coverage reporter. Supported values: 'Codecov'. | **false** | **string** | `codecov` |
108+
| **`coverage`** | Specifify code coverage reporter. Supported values: `codecov`. | **false** | **string** | `codecov` |
109109
| **`working-directory`** | Working directory where the dependencies are installed. | **false** | **string** | `.` |
110110

111111
<!-- inputs:end -->
@@ -133,7 +133,7 @@ on:
133133
134134
jobs:
135135
continuous-integration:
136-
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1
136+
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@4b87508052fc8b08a44a5d2d7d5f0636deb6ea3e # 0.15.0
137137
permissions:
138138
id-token: write
139139
security-events: write

‎actions/dependencies-cache/README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItYXJjaGl2ZSIgY29sb3I9ImdyYXktZGFyayI+PHBvbHlsaW5lIHBvaW50cz0iMjEgOCAyMSAyMSAzIDIxIDMgOCI+PC9wb2x5bGluZT48cmVjdCB4PSIxIiB5PSIzIiB3aWR0aD0iMjIiIGhlaWdodD0iNSI+PC9yZWN0PjxsaW5lIHgxPSIxMCIgeTE9IjEyIiB4Mj0iMTQiIHkyPSIxMiI+PC9saW5lPjwvc3ZnPg==) GitHub Action: Dependencies cache
44

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

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

3535
```yaml
36-
- uses: hoverkraft-tech/ci-github-nodejs/actions/dependencies-cache@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1
36+
- uses: hoverkraft-tech/ci-github-nodejs/actions/dependencies-cache@4b87508052fc8b08a44a5d2d7d5f0636deb6ea3e # 0.15.0
3737
with:
3838
# List of dependencies for which the cache should be managed.
3939
# This input is required.
4040
dependencies: ""
4141

4242
# Working directory where the dependencies are installed.
43+
# Can be absolute or relative to the repository root.
44+
#
4345
# Default: `.`
4446
working-directory: .
4547
```
@@ -54,6 +56,7 @@ Action to setup dependencies cache managment.
5456
| ----------------------- | ----------------------------------------------------------- | ------------ | ----------- |
5557
| **`dependencies`** | List of dependencies for which the cache should be managed. | **true** | - |
5658
| **`working-directory`** | Working directory where the dependencies are installed. | **false** | `.` |
59+
| | Can be absolute or relative to the repository root. | | |
5760

5861
<!-- inputs:end -->
5962

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

Lines changed: 6 additions & 3 deletions
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/e970d0dbe9ef0b2c9d7908a082cdee394d80b51dbba83dab5821ba6e49341f8d/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Get package manager" />
6+
<img src="https://opengraph.githubassets.com/289a3c6fdb0dea3dec9358a0e4b263a847ddd65f34d8b7d3a3cdb0910294881f/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Get package manager" />
77
</div>
88

99
---
@@ -24,7 +24,7 @@
2424

2525
## Overview
2626

27-
Action to detect the package manager used. Supports Yarn and npm
27+
Action to detect the package manager used. Supports Yarn, pnpm, and npm
2828

2929
<!-- overview:end -->
3030

@@ -33,9 +33,11 @@ Action to detect the package manager used. Supports Yarn and npm
3333
## Usage
3434

3535
```yaml
36-
- uses: hoverkraft-tech/ci-github-nodejs/actions/get-package-manager@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1
36+
- uses: hoverkraft-tech/ci-github-nodejs/actions/get-package-manager@4b87508052fc8b08a44a5d2d7d5f0636deb6ea3e # 0.15.0
3737
with:
3838
# Working directory where the dependencies are installed.
39+
# Can be absolute or relative to the repository root.
40+
#
3941
# Default: `.`
4042
working-directory: .
4143
```
@@ -49,6 +51,7 @@ Action to detect the package manager used. Supports Yarn and npm
4951
| **Input** | **Description** | **Required** | **Default** |
5052
| ----------------------- | ------------------------------------------------------- | ------------ | ----------- |
5153
| **`working-directory`** | Working directory where the dependencies are installed. | **false** | `.` |
54+
| | Can be absolute or relative to the repository root. | | |
5255

5356
<!-- inputs:end -->
5457

‎actions/has-installed-dependencies/README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItc2V0dGluZ3MiIGNvbG9yPSJncmF5LWRhcmsiPjxjaXJjbGUgY3g9IjEyIiBjeT0iMTIiIHI9IjMiPjwvY2lyY2xlPjxwYXRoIGQ9Ik0xOS40IDE1YTEuNjUgMS42NSAwIDAgMCAuMzMgMS44MmwuMDYuMDZhMiAyIDAgMCAxIDAgMi44MyAyIDIgMCAwIDEtMi44MyAwbC0uMDYtLjA2YTEuNjUgMS42NSAwIDAgMC0xLjgyLS4zMyAxLjY1IDEuNjUgMCAwIDAtMSAxLjUxVjIxYTIgMiAwIDAgMS0yIDIgMiAyIDAgMCAxLTItMnYtLjA5QTEuNjUgMS42NSAwIDAgMCA5IDE5LjRhMS42NSAxLjY1IDAgMCAwLTEuODIuMzNsLS4wNi4wNmEyIDIgMCAwIDEtMi44MyAwIDIgMiAwIDAgMSAwLTIuODNsLjA2LS4wNmExLjY1IDEuNjUgMCAwIDAgLjMzLTEuODIgMS42NSAxLjY1IDAgMCAwLTEuNTEtMUgzYTIgMiAwIDAgMS0yLTIgMiAyIDAgMCAxIDItMmguMDlBMS42NSAxLjY1IDAgMCAwIDQuNiA5YTEuNjUgMS42NSAwIDAgMC0uMzMtMS44MmwtLjA2LS4wNmEyIDIgMCAwIDEgMC0yLjgzIDIgMiAwIDAgMSAyLjgzIDBsLjA2LjA2YTEuNjUgMS42NSAwIDAgMCAxLjgyLjMzSDlhMS42NSAxLjY1IDAgMCAwIDEtMS41MVYzYTIgMiAwIDAgMSAyLTIgMiAyIDAgMCAxIDIgMnYuMDlhMS42NSAxLjY1IDAgMCAwIDEgMS41MSAxLjY1IDEuNjUgMCAwIDAgMS44Mi0uMzNsLjA2LS4wNmEyIDIgMCAwIDEgMi44MyAwIDIgMiAwIDAgMSAwIDIuODNsLS4wNi4wNmExLjY1IDEuNjUgMCAwIDAtLjMzIDEuODJWOWExLjY1IDEuNjUgMCAwIDAgMS41MSAxSDIxYTIgMiAwIDAgMSAyIDIgMiAyIDAgMCAxLTIgMmgtLjA5YTEuNjUgMS42NSAwIDAgMC0xLjUxIDF6Ij48L3BhdGg+PC9zdmc+) GitHub Action: Has installed dependencies
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/e970d0dbe9ef0b2c9d7908a082cdee394d80b51dbba83dab5821ba6e49341f8d/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Has installed dependencies" />
6+
<img src="https://opengraph.githubassets.com/289a3c6fdb0dea3dec9358a0e4b263a847ddd65f34d8b7d3a3cdb0910294881f/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Has installed dependencies" />
77
</div>
88

99
---
@@ -33,13 +33,15 @@ Action to check if dependencies have been installed according to the package man
3333
## Usage
3434

3535
```yaml
36-
- uses: hoverkraft-tech/ci-github-nodejs/actions/has-installed-dependencies@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1
36+
- uses: hoverkraft-tech/ci-github-nodejs/actions/has-installed-dependencies@4b87508052fc8b08a44a5d2d7d5f0636deb6ea3e # 0.15.0
3737
with:
3838
# The dependencies to check.
3939
# This input is required.
4040
dependencies: ""
4141

4242
# Working directory where the dependencies are installed.
43+
# Can be absolute or relative to the repository root.
44+
#
4345
# Default: `.`
4446
working-directory: .
4547
```
@@ -54,6 +56,7 @@ Action to check if dependencies have been installed according to the package man
5456
| ----------------------- | ------------------------------------------------------- | ------------ | ----------- |
5557
| **`dependencies`** | The dependencies to check. | **true** | - |
5658
| **`working-directory`** | Working directory where the dependencies are installed. | **false** | `.` |
59+
| | Can be absolute or relative to the repository root. | | |
5760

5861
<!-- inputs:end -->
5962

‎actions/setup-node/README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItc2V0dGluZ3MiIGNvbG9yPSJncmF5LWRhcmsiPjxjaXJjbGUgY3g9IjEyIiBjeT0iMTIiIHI9IjMiPjwvY2lyY2xlPjxwYXRoIGQ9Ik0xOS40IDE1YTEuNjUgMS42NSAwIDAgMCAuMzMgMS44MmwuMDYuMDZhMiAyIDAgMCAxIDAgMi44MyAyIDIgMCAwIDEtMi44MyAwbC0uMDYtLjA2YTEuNjUgMS42NSAwIDAgMC0xLjgyLS4zMyAxLjY1IDEuNjUgMCAwIDAtMSAxLjUxVjIxYTIgMiAwIDAgMS0yIDIgMiAyIDAgMCAxLTItMnYtLjA5QTEuNjUgMS42NSAwIDAgMCA5IDE5LjRhMS42NSAxLjY1IDAgMCAwLTEuODIuMzNsLS4wNi4wNmEyIDIgMCAwIDEtMi44MyAwIDIgMiAwIDAgMSAwLTIuODNsLjA2LS4wNmExLjY1IDEuNjUgMCAwIDAgLjMzLTEuODIgMS42NSAxLjY1IDAgMCAwLTEuNTEtMUgzYTIgMiAwIDAgMS0yLTIgMiAyIDAgMCAxIDItMmguMDlBMS42NSAxLjY1IDAgMCAwIDQuNiA5YTEuNjUgMS42NSAwIDAgMC0uMzMtMS44MmwtLjA2LS4wNmEyIDIgMCAwIDEgMC0yLjgzIDIgMiAwIDAgMSAyLjgzIDBsLjA2LjA2YTEuNjUgMS42NSAwIDAgMCAxLjgyLjMzSDlhMS42NSAxLjY1IDAgMCAwIDEtMS41MVYzYTIgMiAwIDAgMSAyLTIgMiAyIDAgMCAxIDIgMnYuMDlhMS42NSAxLjY1IDAgMCAwIDEgMS41MSAxLjY1IDEuNjUgMCAwIDAgMS44Mi0uMzNsLjA2LS4wNmEyIDIgMCAwIDEgMi44MyAwIDIgMiAwIDAgMSAwIDIuODNsLS4wNi4wNmExLjY1IDEuNjUgMCAwIDAtLjMzIDEuODJWOWExLjY1IDEuNjUgMCAwIDAgMS41MSAxSDIxYTIgMiAwIDAgMSAyIDIgMiAyIDAgMCAxLTIgMmgtLjA5YTEuNjUgMS42NSAwIDAgMC0xLjUxIDF6Ij48L3BhdGg+PC9zdmc+) GitHub Action: Setup Node.js
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/d404625773c747748dc7d301c22e3486f68a45a9b6ecf6dcbbc8827f4cf9ccf8/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Setup Node.js" />
6+
<img src="https://opengraph.githubassets.com/289a3c6fdb0dea3dec9358a0e4b263a847ddd65f34d8b7d3a3cdb0910294881f/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Setup Node.js" />
77
</div>
88

99
---
@@ -33,12 +33,14 @@ Action to setup Node.js and install dependencies according to the package manage
3333
## Usage
3434

3535
```yaml
36-
- uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@1d00c9eb280acbee5df4b4a2087f786e66b13d87 # 0.14.1
36+
- uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@4b87508052fc8b08a44a5d2d7d5f0636deb6ea3e # 0.15.0
3737
with:
3838
# List of dependencies for which the cache should be managed
3939
dependencies-cache: ""
4040

4141
# Working directory where the dependencies are installed.
42+
# Can be absolute or relative to the repository root.
43+
#
4244
# Default: `.`
4345
working-directory: .
4446
```
@@ -53,6 +55,7 @@ Action to setup Node.js and install dependencies according to the package manage
5355
| ------------------------ | ---------------------------------------------------------- | ------------ | ----------- |
5456
| **`dependencies-cache`** | List of dependencies for which the cache should be managed | **false** | - |
5557
| **`working-directory`** | Working directory where the dependencies are installed. | **false** | `.` |
58+
| | Can be absolute or relative to the repository root. | | |
5659

5760
<!-- inputs:end -->
5861

0 commit comments

Comments
 (0)