Skip to content

Commit 5f0ea21

Browse files
docs: update actions and workflows documentation
[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent a180b74 commit 5f0ea21

File tree

4 files changed

+36
-9
lines changed

4 files changed

+36
-9
lines changed

actions/dependencies-cache/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,20 @@ Action to setup dependencies cache managment.
1818
# Description: List of dependencies for which the cache should be managed.
1919
#
2020
dependencies: ""
21+
22+
# Description: Working directory where the dependencies are installed.
23+
#
24+
# Default: .
25+
working-directory: ""
2126
```
2227
2328
<!-- end usage -->
2429
<!-- start inputs -->
2530
26-
| **Input** | **Description** | **Default** | **Required** |
27-
| ------------------------- | ----------------------------------------------------------- | ----------- | ------------ |
28-
| <code>dependencies</code> | List of dependencies for which the cache should be managed. | | **true** |
31+
| **Input** | **Description** | **Default** | **Required** |
32+
| ------------------------------ | ----------------------------------------------------------- | -------------- | ------------ |
33+
| <code>dependencies</code> | List of dependencies for which the cache should be managed. | | **true** |
34+
| <code>working-directory</code> | Working directory where the dependencies are installed. | <code>.</code> | **false** |
2935
3036
<!-- end inputs -->
3137
<!-- start outputs -->

actions/get-package-manager/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,19 @@ Action to detect the package manager used. Supports Yarn and npm
1515
```yaml
1616
- uses: hoverkraft-tech/[email protected]
1717
with:
18+
# Description: Working directory where the dependencies are installed.
19+
#
20+
# Default: .
21+
working-directory: ""
1822
```
1923
2024
<!-- end usage -->
2125
<!-- start inputs -->
26+
27+
| **Input** | **Description** | **Default** | **Required** |
28+
| ------------------------------ | ------------------------------------------------------- | -------------- | ------------ |
29+
| <code>working-directory</code> | Working directory where the dependencies are installed. | <code>.</code> | **false** |
30+
2231
<!-- end inputs -->
2332
<!-- start outputs -->
2433

actions/has-installed-dependencies/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,20 @@ Action to check if dependencies have been installed according to the package man
1818
# Description: The dependencies to check.
1919
#
2020
dependencies: ""
21+
22+
# Description: Working directory where the dependencies are installed.
23+
#
24+
# Default: .
25+
working-directory: ""
2126
```
2227
2328
<!-- end usage -->
2429
<!-- start inputs -->
2530
26-
| **Input** | **Description** | **Default** | **Required** |
27-
| ------------------------- | -------------------------- | ----------- | ------------ |
28-
| <code>dependencies</code> | The dependencies to check. | | **true** |
31+
| **Input** | **Description** | **Default** | **Required** |
32+
| ------------------------------ | ------------------------------------------------------- | -------------- | ------------ |
33+
| <code>dependencies</code> | The dependencies to check. | | **true** |
34+
| <code>working-directory</code> | Working directory where the dependencies are installed. | <code>.</code> | **false** |
2935
3036
<!-- end inputs -->
3137
<!-- start outputs -->

actions/setup-node/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,20 @@ Action to setup Node.js and install dependencies according to the package manage
1919
#
2020
# Default:
2121
dependencies-cache: ""
22+
23+
# Description: Working directory where the dependencies are installed.
24+
#
25+
# Default: .
26+
working-directory: ""
2227
```
2328
2429
<!-- end usage -->
2530
<!-- start inputs -->
2631
27-
| **Input** | **Description** | **Default** | **Required** |
28-
| ------------------------------- | ---------------------------------------------------------- | ----------- | ------------ |
29-
| <code>dependencies-cache</code> | List of dependencies for which the cache should be managed | | **false** |
32+
| **Input** | **Description** | **Default** | **Required** |
33+
| ------------------------------- | ---------------------------------------------------------- | -------------- | ------------ |
34+
| <code>dependencies-cache</code> | List of dependencies for which the cache should be managed | | **false** |
35+
| <code>working-directory</code> | Working directory where the dependencies are installed. | <code>.</code> | **false** |
3036
3137
<!-- end inputs -->
3238
<!-- start outputs -->

0 commit comments

Comments
 (0)