Skip to content

Commit

Permalink
add github-token to README examples (#24)
Browse files Browse the repository at this point in the history
This is likely a safe default to prevent people from running into API rate limiting.
  • Loading branch information
kevinschoonover authored Apr 21, 2023
1 parent 135d686 commit 8030b48
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ jobs:
steps:
- uses: earthly/actions-setup@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
version: "latest" # or pin to an specific version, e.g. "0.7.1"
- uses: actions/checkout@v2
- name: Docker login # to avoid dockerhub rate-limiting
Expand All @@ -39,6 +40,8 @@ Install the latest version of earthly:
```yaml
- name: Install earthly
uses: earthly/actions-setup@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
```
Install a specific version of earthly:
Expand All @@ -47,6 +50,7 @@ Install a specific version of earthly:
- name: Install earthly
uses: earthly/actions-setup@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
version: 0.6.1
```
Expand All @@ -56,6 +60,7 @@ Install a version that adheres to a semver range
- name: Install earthly
uses: earthly/actions-setup@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
version: ^0.6.0
```
Expand All @@ -73,3 +78,4 @@ The action can be configured with the following arguments:
- `github-token` (optional) - Token used to query earthly versions.
- `prerelease` (optional) - allow prerelease versions.
- `use-cache` (optional) - whether to use the cache to store earthly or not.
- `github-token` (optional) - GitHub token for fetching earthly version list. Recommended to avoid GitHub API ratelimit.

0 comments on commit 8030b48

Please sign in to comment.