Skip to content

Commit 1d26654

Browse files
Document - Included instruction for GITHUB_AUTH_TOKEN
Included instruction that GITHUB_AUTH_TOKEN supports round robin with multiple tokens.
1 parent 1700c3a commit 1d26654

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Security Scorecards
2+
23
![build](https://github.com/ossf/scorecard/workflows/build/badge.svg?branch=main)
34
![golangci-lint](https://github.com/ossf/scorecard/workflows/golangci-lint/badge.svg?branch=main)
45
![CodeQL](https://github.com/ossf/scorecard/workflows/CodeQL/badge.svg?branch=main)
@@ -106,6 +107,10 @@ export GITHUB_AUTH_TOKEN=<your access token>
106107
set GITHUB_AUTH_TOKEN=<your access token>
107108
```
108109

110+
#### GITHUB_AUTH_TOKEN
111+
112+
Multiple `GITHUB_AUTH_TOKEN` can be provided separated by comma to be utilized in a round robin fashion.
113+
109114
As an alternative to personal access tokens, we also support GitHub App Installations
110115
for higher rate-limit quotas.
111116
If you have an installed GitHub App and key file, you can use these three environment
@@ -134,9 +139,9 @@ The following checks are all run against the target project:
134139
| Code-Review | Does the project require code review before code is merged? |
135140
| CII-Best-Practices | Does the project have a [CII Best Practices Badge](https://bestpractices.coreinfrastructure.org/en)? |
136141
| Pull-Requests | Does the project use [Pull Requests](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests) for all code changes? |
137-
| Fuzzing | Does the project use fuzzing tools, e.g. [OSS-Fuzz](https://github.com/google/oss-fuzz)? |
142+
| Fuzzing | Does the project use fuzzing tools, e.g. [OSS-Fuzz](https://github.com/google/oss-fuzz)? |
138143
| SAST | Does the project use static code analysis tools, e.g. [CodeQL](https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning-for-a-repository#enabling-code-scanning-using-actions), [SonarCloud](https://sonarcloud.io)? |
139-
| Active | Did the project get any commits in the last 90 days? |
144+
| Active | Did the project get any commits in the last 90 days? |
140145
| Branch-Protection | Does the project use [Branch Protection](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/about-protected-branches) ? |
141146

142147
To see detailed information on how each check works, see the [check-specific documentation page](checks.md).

0 commit comments

Comments
 (0)