diff --git a/actions/dependencies-cache/README.md b/actions/dependencies-cache/README.md index 1be3f841..5a85e676 100644 --- a/actions/dependencies-cache/README.md +++ b/actions/dependencies-cache/README.md @@ -1,6 +1,6 @@ -# GitHub Action: Dependencies cache +# branding<icon:archive color:gray-dark> GitHub Action: Dependencies cache @@ -13,21 +13,19 @@ Action to setup dependencies cache managment. ```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: "" ``` -## Inputs - -| **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** | diff --git a/actions/get-package-manager/README.md b/actions/get-package-manager/README.md index 0643bca4..5f13e1dc 100644 --- a/actions/get-package-manager/README.md +++ b/actions/get-package-manager/README.md @@ -1,6 +1,6 @@ -# GitHub Action: Get package manager +# branding<icon:package color:gray-dark> GitHub Action: Get package manager @@ -13,7 +13,7 @@ Action to detect the package manager used. Supports Yarn and npm ```yaml -- uses: hoverkraft-tech/ci-github-nodejs/actions/get-package-manager@v0.1.0 +- uses: hoverkraft-tech/ci-github-nodejs@0.4.2 with: ``` @@ -22,9 +22,12 @@ Action to detect the package manager used. Supports Yarn and npm -| \***\*Output\*\*** | \***\*Description\*\*** | \***\*Default\*\*** | \***\*Required\*\*** | -| ---------------------------- | ------------------------ | ------------------- | -------------------- | -| package-manager | The package manager used | undefined | undefined | +| **Output** | **Description** | +| ---------------------------------- | ----------------------------------------------------- | +| package-manager | The package manager used. | +| cache-dependency-path | The path to the dependency file for cache management. | +| install-command | The command to install dependencies. | +| run-script-command | The command to run a script in the package.json file. | diff --git a/actions/has-installed-dependencies/README.md b/actions/has-installed-dependencies/README.md index f06e2e82..11f4f34e 100644 --- a/actions/has-installed-dependencies/README.md +++ b/actions/has-installed-dependencies/README.md @@ -1,6 +1,6 @@ -# GitHub Action: Has installed dependencies +# branding<icon:settings color:gray-dark> GitHub Action: Has installed dependencies @@ -13,29 +13,26 @@ Action to check if dependencies have been installed according to the package man ```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: "" ``` -## Inputs - -| **Input** | **Description** | **Default** | **Required** | -| ----------------------------- | -------------------------- | ----------- | ------------ | -| **dependencies** | The dependencies to check. | | **true** | +| **Input** | **Description** | **Default** | **Required** | +| ------------------------- | -------------------------- | ----------- | ------------ | +| dependencies | The dependencies to check. | | **true** | -## Outputs - -| **Output** | **Description** | **Default** | **Required** | -| ----------------------------------- | ----------------------------------------------------------------------------- | ----------- | ------------ | -| installed-dependencies | A map of dependencies and the status weither they have been installed or not. | undefined | undefined | +| **Output** | **Description** | +| ----------------------------------- | ----------------------------------------------------------------------------- | +| installed-dependencies | A map of dependencies and the status weither they have been installed or not. | diff --git a/actions/setup-node/README.md b/actions/setup-node/README.md index 8b18634c..6e5e154d 100644 --- a/actions/setup-node/README.md +++ b/actions/setup-node/README.md @@ -1,6 +1,6 @@ -# GitHub Action: Setup NodeJS +# branding<icon:settings color:gray-dark> GitHub Action: Setup NodeJS @@ -13,13 +13,28 @@ Action to setup NodeJS and install dependencies according to the package manager ```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: "" ``` + +| **Input** | **Description** | **Default** | **Required** | +| ------------------------------- | ---------------------------------------------------------- | ----------- | ------------ | +| dependencies-cache | List of dependencies for which the cache should be managed | | **false** | + + +| **Output** | **Description** | +| ------------------------------- | ---------------------------------------------------- | +| run-script-command | The command to run a script in the package.json file | +