Skip to content

docs: update actions and workflows documentation #114

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 5, 2024
Merged

docs: update actions and workflows documentation #114

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
18 changes: 8 additions & 10 deletions actions/dependencies-cache/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- start title -->

# GitHub Action: Dependencies cache
# <img src=".github/ghadocs/branding.svg" width="60px" align="center" alt="branding<icon:archive color:gray-dark>" /> GitHub Action: Dependencies cache

<!-- end title -->
<!-- start description -->
Expand All @@ -13,21 +13,19 @@ Action to setup dependencies cache managment.
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-nodejs/actions/dependencies-cache@0.3.0
- uses: hoverkraft-tech/ci-github-nodejs@0.4.2
with:
dependencies: |
nx
jest
# Description: List of dependencies for which the cache should be managed.
#
dependencies: ""
```

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

## 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** |

<!-- end inputs -->
<!-- start outputs -->
Expand Down
13 changes: 8 additions & 5 deletions actions/get-package-manager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- start title -->

# GitHub Action: Get package manager
# <img src=".github/ghadocs/branding.svg" width="60px" align="center" alt="branding<icon:package color:gray-dark>" /> GitHub Action: Get package manager

<!-- end title -->
<!-- start description -->
Expand All @@ -13,7 +13,7 @@ Action to detect the package manager used. Supports Yarn and npm
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-nodejs/actions/get-package-manager@v0.1.0
- uses: hoverkraft-tech/ci-github-nodejs@0.4.2
with:
```

Expand All @@ -22,9 +22,12 @@ Action to detect the package manager used. Supports Yarn and npm
<!-- end inputs -->
<!-- start outputs -->

| \***\*Output\*\*** | \***\*Description\*\*** | \***\*Default\*\*** | \***\*Required\*\*** |
| ---------------------------- | ------------------------ | ------------------- | -------------------- |
| <code>package-manager</code> | The package manager used | undefined | undefined |
| **Output** | **Description** |
| ---------------------------------- | ----------------------------------------------------- |
| <code>package-manager</code> | The package manager used. |
| <code>cache-dependency-path</code> | The path to the dependency file for cache management. |
| <code>install-command</code> | The command to install dependencies. |
| <code>run-script-command</code> | The command to run a script in the package.json file. |

<!-- end outputs -->
<!-- start [.github/ghadocs/examples/] -->
Expand Down
23 changes: 10 additions & 13 deletions actions/has-installed-dependencies/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- start title -->

# GitHub Action: Has installed dependencies
# <img src=".github/ghadocs/branding.svg" width="60px" align="center" alt="branding<icon:settings color:gray-dark>" /> GitHub Action: Has installed dependencies

<!-- end title -->
<!-- start description -->
Expand All @@ -13,29 +13,26 @@ Action to check if dependencies have been installed according to the package man
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-nodejs/actions/has-installed-dependencies@v0.1.0
- uses: hoverkraft-tech/ci-github-nodejs@0.4.2
with:
# The dependencies to check.
# Description: The dependencies to check.
#
dependencies: ""
```

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

## 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** |

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

## Outputs

| **Output** | **Description** | **Default** | **Required** |
| ----------------------------------- | ----------------------------------------------------------------------------- | ----------- | ------------ |
| <code>installed-dependencies</code> | A map of dependencies and the status weither they have been installed or not. | undefined | undefined |
| **Output** | **Description** |
| ----------------------------------- | ----------------------------------------------------------------------------- |
| <code>installed-dependencies</code> | A map of dependencies and the status weither they have been installed or not. |

<!-- end outputs -->
<!-- start [.github/ghadocs/examples/] -->
Expand Down
19 changes: 17 additions & 2 deletions actions/setup-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- start title -->

# GitHub Action: Setup NodeJS
# <img src=".github/ghadocs/branding.svg" width="60px" align="center" alt="branding<icon:settings color:gray-dark>" /> GitHub Action: Setup NodeJS

<!-- end title -->
<!-- start description -->
Expand All @@ -13,13 +13,28 @@ Action to setup NodeJS and install dependencies according to the package manager
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@v0.1.0
- uses: hoverkraft-tech/ci-github-nodejs@0.4.2
with:
# Description: List of dependencies for which the cache should be managed
#
# Default:
dependencies-cache: ""
```

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

| **Input** | **Description** | **Default** | **Required** |
| ------------------------------- | ---------------------------------------------------------- | ----------- | ------------ |
| <code>dependencies-cache</code> | List of dependencies for which the cache should be managed | | **false** |

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

| **Output** | **Description** |
| ------------------------------- | ---------------------------------------------------- |
| <code>run-script-command</code> | The command to run a script in the package.json file |

<!-- end outputs -->
<!-- start [.github/ghadocs/examples/] -->
<!-- end [.github/ghadocs/examples/] -->