From 7811eb3036174696b081592a9c3e175848f7fe89 Mon Sep 17 00:00:00 2001 From: "hoverkraft-bot[bot]" <128996893+hoverkraft-bot[bot]@users.noreply.github.com> Date: Sat, 19 Apr 2025 21:55:00 +0000 Subject: [PATCH] docs: update actions and workflows documentation [skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- actions/dependencies-cache/README.md | 12 +++++++++--- actions/get-package-manager/README.md | 9 +++++++++ actions/has-installed-dependencies/README.md | 12 +++++++++--- actions/setup-node/README.md | 12 +++++++++--- 4 files changed, 36 insertions(+), 9 deletions(-) diff --git a/actions/dependencies-cache/README.md b/actions/dependencies-cache/README.md index d8461a66..d7f09383 100644 --- a/actions/dependencies-cache/README.md +++ b/actions/dependencies-cache/README.md @@ -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: "" ``` -| **Input** | **Description** | **Default** | **Required** | -| ------------------------- | ----------------------------------------------------------- | ----------- | ------------ | -| dependencies | List of dependencies for which the cache should be managed. | | **true** | +| **Input** | **Description** | **Default** | **Required** | +| ------------------------------ | ----------------------------------------------------------- | -------------- | ------------ | +| dependencies | List of dependencies for which the cache should be managed. | | **true** | +| working-directory | Working directory where the dependencies are installed. | . | **false** | diff --git a/actions/get-package-manager/README.md b/actions/get-package-manager/README.md index e9afe649..3ea093be 100644 --- a/actions/get-package-manager/README.md +++ b/actions/get-package-manager/README.md @@ -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: "" ``` + +| **Input** | **Description** | **Default** | **Required** | +| ------------------------------ | ------------------------------------------------------- | -------------- | ------------ | +| working-directory | Working directory where the dependencies are installed. | . | **false** | + diff --git a/actions/has-installed-dependencies/README.md b/actions/has-installed-dependencies/README.md index 42e0e967..e74ddff3 100644 --- a/actions/has-installed-dependencies/README.md +++ b/actions/has-installed-dependencies/README.md @@ -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: "" ``` -| **Input** | **Description** | **Default** | **Required** | -| ------------------------- | -------------------------- | ----------- | ------------ | -| dependencies | The dependencies to check. | | **true** | +| **Input** | **Description** | **Default** | **Required** | +| ------------------------------ | ------------------------------------------------------- | -------------- | ------------ | +| dependencies | The dependencies to check. | | **true** | +| working-directory | Working directory where the dependencies are installed. | . | **false** | diff --git a/actions/setup-node/README.md b/actions/setup-node/README.md index 288d3780..eb0f2319 100644 --- a/actions/setup-node/README.md +++ b/actions/setup-node/README.md @@ -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: "" ``` -| **Input** | **Description** | **Default** | **Required** | -| ------------------------------- | ---------------------------------------------------------- | ----------- | ------------ | -| dependencies-cache | List of dependencies for which the cache should be managed | | **false** | +| **Input** | **Description** | **Default** | **Required** | +| ------------------------------- | ---------------------------------------------------------- | -------------- | ------------ | +| dependencies-cache | List of dependencies for which the cache should be managed | | **false** | +| working-directory | Working directory where the dependencies are installed. | . | **false** |