fail fast on github rate limit (#263)

imranismail · Sep 6, 2022 · 5bd9c67 · 5bd9c67
1 parent 97446b2
commit 5bd9c67
Show file tree

Hide file tree

Showing 5 changed files with 239 additions and 130 deletions.
diff --git a/README.md b/README.md
@@ -8,10 +8,11 @@ Install any kustomize version as a step in your workflow
 
 Every argument is optional.
 
-| Input               | Description                                                                                            |
-| ------------------- | ------------------------------------------------------------------------------------------------------ |
-| `github-token`      | PAT (Personal Access Token) for authorizing the repository.<br>_Defaults to **\${{ github.token }}**_ |
-| `kustomize-version` | Semver of kustomize to use. Examples: `10.x`, `10.15.1`, `>=10.15.0`<br>_Defaults to **\***_       |
+| Input               | Description                                                                                                                                                                                                                             |
+| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `github-token`      | PAT (Personal Access Token) for authorizing the repository.<br>_Defaults to **\${{ github.token }}**_                                                                                                                                   |
+| `kustomize-version` | Semver of kustomize to use. Examples: `10.x`, `10.15.1`, `>=10.15.0`<br>_Defaults to **\***_                                                                                                                                            |
+| `fail-fast`         | When github rate limits us, fail immediately or retry after the timeout that github wishes from us? Note: When setting this to `false` (which is the default!), a github workflow might accrue a long (and possibly expensive) runtime. |
 
 ## Usage
 

diff --git a/action.yml b/action.yml
@@ -13,6 +13,10 @@ inputs:
     description: 'Token for the repository. Can be passed in using `{{ secrets.GITHUB_TOKEN }}`.'
     required: false
     default: ${{ github.token }}
+  fail-fast:
+    description: 'Fail quickly on github rate limit. "false" or "true".'
+    required: false
+    default: 'false'
 runs:
   using: 'node12'
   main: 'dist/index.js'