Skip to content

Commit ba6bb29

Browse files
Set default GitHub token (#89)
Co-authored-by: Ben Drucker <bvdrucker@gmail.com>
1 parent 0545464 commit ba6bb29

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ Default: `"latest"`
1515

1616
### `github_token`
1717

18-
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.
18+
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.
19+
20+
Default: `${{ github.token }}`
1921

2022
## Outputs
2123

@@ -75,12 +77,12 @@ or specify it explicitly as
7577
tflint_version: latest
7678
```
7779
78-
### Using `GITHUB_TOKEN`
80+
### Using Custom GitHub Token
7981
8082
```yaml
8183
- uses: terraform-linters/setup-tflint@v2
8284
with:
83-
github_token: ${{ secrets.GITHUB_TOKEN }}
85+
github_token: ${{ secrets.MY_CUSTOM_GITHUB_TOKEN }}
8486
```
8587
8688
### Loading Shared Configuration

action.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ inputs:
88
github_token:
99
description: GitHub token - used when getting the latest version of tflint
1010
required: false
11+
default: ${{ github.token }}
1112
runs:
1213
using: 'node16'
1314
main: 'dist/index.js'

0 commit comments

Comments
 (0)