Skip to content

docs: update actions and workflows documentation #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hoverkraft-bot merged 1 commit into from
Apr 19, 2025
Merged

docs: update actions and workflows documentation #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions actions/dependencies-cache/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,20 @@ Action to setup dependencies cache managment.
# Description: List of dependencies for which the cache should be managed.
#
dependencies: ""

# Description: Working directory where the dependencies are installed.
#
# Default: .
working-directory: ""
```

<!-- end usage -->
<!-- start inputs -->

| **Input** | **Description** | **Default** | **Required** |
| ------------------------- | ----------------------------------------------------------- | ----------- | ------------ |
| <code>dependencies</code> | List of dependencies for which the cache should be managed. | | **true** |
| **Input** | **Description** | **Default** | **Required** |
| ------------------------------ | ----------------------------------------------------------- | -------------- | ------------ |
| <code>dependencies</code> | List of dependencies for which the cache should be managed. | | **true** |
| <code>working-directory</code> | Working directory where the dependencies are installed. | <code>.</code> | **false** |

<!-- end inputs -->
<!-- start outputs -->
Expand Down
9 changes: 9 additions & 0 deletions actions/get-package-manager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,19 @@ Action to detect the package manager used. Supports Yarn and npm
```yaml
- uses: hoverkraft-tech/ci-github-nodejs@0.10.0
with:
# Description: Working directory where the dependencies are installed.
#
# Default: .
working-directory: ""
```

<!-- end usage -->
<!-- start inputs -->

| **Input** | **Description** | **Default** | **Required** |
| ------------------------------ | ------------------------------------------------------- | -------------- | ------------ |
| <code>working-directory</code> | Working directory where the dependencies are installed. | <code>.</code> | **false** |

<!-- end inputs -->
<!-- start outputs -->

Expand Down
12 changes: 9 additions & 3 deletions actions/has-installed-dependencies/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,20 @@ Action to check if dependencies have been installed according to the package man
# Description: The dependencies to check.
#
dependencies: ""

# Description: Working directory where the dependencies are installed.
#
# Default: .
working-directory: ""
```

<!-- end usage -->
<!-- start inputs -->

| **Input** | **Description** | **Default** | **Required** |
| ------------------------- | -------------------------- | ----------- | ------------ |
| <code>dependencies</code> | The dependencies to check. | | **true** |
| **Input** | **Description** | **Default** | **Required** |
| ------------------------------ | ------------------------------------------------------- | -------------- | ------------ |
| <code>dependencies</code> | The dependencies to check. | | **true** |
| <code>working-directory</code> | Working directory where the dependencies are installed. | <code>.</code> | **false** |

<!-- end inputs -->
<!-- start outputs -->
Expand Down
12 changes: 9 additions & 3 deletions actions/setup-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,20 @@ Action to setup Node.js and install dependencies according to the package manage
#
# Default:
dependencies-cache: ""

# Description: Working directory where the dependencies are installed.
#
# Default: .
working-directory: ""
```

<!-- end usage -->
<!-- start inputs -->

| **Input** | **Description** | **Default** | **Required** |
| ------------------------------- | ---------------------------------------------------------- | ----------- | ------------ |
| <code>dependencies-cache</code> | List of dependencies for which the cache should be managed | | **false** |
| **Input** | **Description** | **Default** | **Required** |
| ------------------------------- | ---------------------------------------------------------- | -------------- | ------------ |
| <code>dependencies-cache</code> | List of dependencies for which the cache should be managed | | **false** |
| <code>working-directory</code> | Working directory where the dependencies are installed. | <code>.</code> | **false** |

<!-- end inputs -->
<!-- start outputs -->
Expand Down