Set default GitHub token (#89)

Co-authored-by: Ben Drucker <bvdrucker@gmail.com>
terraform-linters · Nov 17, 2022 · ba6bb29 · ba6bb29
1 parent 0545464
commit ba6bb29
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,9 @@ Default: `"latest"`
 
 ### `github_token`
 
-If set, `github_token` will be used for Octokit authentication. Authenticating will increase the [API rate limit](https://developer.github.com/v3/#rate-limiting) when querying the tflint repository to get the latest release version.
+Used to authenticate requests to the GitHub API to obtain release data from the TFLint repository. Authenticating will increase the [API rate limit](https://developer.github.com/v3/#rate-limiting). Any valid token is supported. No permissions are required.
+
+Default: `${{ github.token }}`
 
 ## Outputs
 
@@ -75,12 +77,12 @@ or specify it explicitly as
     tflint_version: latest
 ```
 
-### Using `GITHUB_TOKEN`
+### Using Custom GitHub Token
 
 ```yaml
 - uses: terraform-linters/setup-tflint@v2
   with:
-    github_token: ${{ secrets.GITHUB_TOKEN }}
+    github_token: ${{ secrets.MY_CUSTOM_GITHUB_TOKEN }}
 ```
 
 ### Loading Shared Configuration

diff --git a/action.yml b/action.yml
@@ -8,6 +8,7 @@ inputs:
   github_token:
     description: GitHub token - used when getting the latest version of tflint
     required: false
+    default: ${{ github.token }}
 runs:
   using: 'node16'
   main: 'dist/index.js'