[FX-NULL] Rename max attempts parameter in yarn-install (#257)

toptal · Jan 5, 2024 · 27cad6c · 27cad6c
1 parent 21fb6e1
commit 27cad6c
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/.changeset/nine-actors-camp.md b/.changeset/nine-actors-camp.md
@@ -0,0 +1,5 @@
+---
+'davinci-github-actions': patch
+---
+
+- rename max attempts parameter in `yarn-install`
diff --git a/yarn-install/README.md b/yarn-install/README.md
@@ -17,7 +17,7 @@ The list of arguments, that are used in GH Action:
 | `path`           | string |          | .       | Relative path under $GITHUB\_WORKSPACE where to run `yarn install` command                                                                                                                                                                  |
 | `checkout-token` | string |          |         | Repository checkout access token `GITHUB_TOKEN`. Required for self-hosted runners                                                                                                                                                           |
 | `npm-gar-token`  | string |          |         | Repository npm Artifact Registry access token `NPM_GAR_TOKEN`. Required when using self-hosted runners with npm in GAR (Google Artifact Registry, the npm registry works as a proxy-cache, downloading and storing the public npm packages) |
-| `maxAttempts`    | string |          | 1       | How many times to retry installing. This is specially useful if the building of packages might fail because of network connections                                                                                                          |
+| `max-attempts`   | string |          | 1       | How many times to retry installing. This is specially useful if the building of packages might fail because of network connections                                                                                                          |
 
 ### Outputs
 

diff --git a/yarn-install/action.yml b/yarn-install/action.yml
@@ -18,7 +18,7 @@ inputs:
   npm-gar-token:
     description: Repository npm Artifact Registry access token `NPM_GAR_TOKEN`. Required when using self-hosted runners with npm in GAR (Google Artifact Registry, the npm registry works as a proxy-cache, downloading and storing the public npm packages)
     required: false
-  maxAttempts:
+  max-attempts:
     description: How many times to retry installing. This is specially useful if the building of packages might fail because of network connections
     default: "1"
     required: false