Skip to content

Commit ada8239

Browse files
authored
docs: add guidance on auth for GHES users (#186)
1 parent 7e14708 commit ada8239

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ Used to authenticate requests to the GitHub API to obtain release data from the
1919

2020
Default: `${{ github.token }}`
2121

22+
To disable authentication, set this value to an empty string (`""`). GitHub Enterprise Server tokens will not be accepted by `github.com`. GHES users must either:
23+
24+
* Disable authentication
25+
* Provide an API token issued from `github.com`
26+
* [Apps](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps) are the preferred way to authenticate on behalf of an organization
27+
2228
### `tflint_wrapper`
2329

2430
Installs a wrapper script to wrap subsequent calls to `tflint` and expose `stdout`, `stderr`, and `exitcode` outputs.

0 commit comments

Comments
 (0)