Skip to content

Commit 9a0fda8

Browse files
authored
Merge pull request #169 from tailscale/mpminardi/document-use-cache
README.md: document the `use-cache` input
2 parents 32856f8 + 91154e3 commit 9a0fda8

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,19 @@ If you'd like to specify the latest version, simply set the version as `latest`
7777

7878
You can find the latest Tailscale stable version number at
7979
https://pkgs.tailscale.com/stable/#static.
80+
81+
82+
## Cache Tailscale binaries
83+
84+
Caching can reduce download times and download failures on runners with slower network connectivity. Although caching is not enabled by default, it is generally recommended.
85+
86+
You can opt in to caching Tailscale binaries by passing `'true'` to the `use-cache` input:
87+
88+
```yaml
89+
- name: Tailscale
90+
uses: tailscale/github-action@v3
91+
with:
92+
oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
93+
oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
94+
use-cache: 'true'
95+
```

0 commit comments

Comments
 (0)