Skip to content

Commit

Permalink
docs: remove caveats
Browse files Browse the repository at this point in the history
  • Loading branch information
nhedger committed May 19, 2023
1 parent 8396fee commit 15c285e
Showing 1 changed file with 0 additions and 23 deletions.
23 changes: 0 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,29 +58,6 @@ Install version `3.7.3` of SOPS.
run: sops --version
```

## Caveats

This action makes HTTP requests to the GitHub REST API to determine the URL of
the assets to download. By default, these requests are made anonymously,
which means that they are subject to harsher rate limits.

> GitHub-hosted **macOS** runners are typically subject to this issue, because
> most of them share a common IP address, which increases the likelihood of
> hitting the rate limit.

If you encounter rate limiting issues, try setting the `GITHUB_TOKEN`
environment variable to authenticate the requests and increase the
[rate limit][rate-limit].

[rate-limit]: https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration#usage-limits

```yaml
- name: Setup SOPS
uses: nhedger/setup-sops@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

## License

The scripts and documentation in this project are licensed under
Expand Down

0 comments on commit 15c285e

Please sign in to comment.