earthly/actions-setup
0
0
Fork 0
mirror of https://github.com/earthly/actions-setup.git synced 2024-12-27 14:51:02 +08:00
Code Issues Projects Releases Wiki Activity

add github-token to README examples (#24)

Browse Source 
This is likely a safe default to prevent people from running into API rate limiting.
This commit is contained in:
Kevin Schoonover 2023-04-21 11:05:03 -07:00 committed by GitHub
parent 135d686cdc
commit 8030b48a82
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -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
@ -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:
@ -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
```
@ -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
```
@ -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.