Update README.md some more.

Signed-off-by: Denton Gentry <dgentry@tailscale.com>
This commit is contained in:
Denton Gentry 2021-08-06 08:33:29 -07:00
parent 4b48374c75
commit 16dc1ccef1

View file

@ -1,7 +1,7 @@
# Tailscale GitHub Action
This GitHub Action connects to your [Tailscale network](https://tailscale.com)
by adding a Tailscale step to the workflow.
by adding a step to your workflow.
```yaml
- name: Tailscale
@ -10,7 +10,7 @@ by adding a Tailscale step to the workflow.
authkey: ${{ secrets.TAILSCALE_AUTHKEY }}
```
Subsequent steps in the Action can then access IP addresses in your Tailnet.
Subsequent steps in the Action can then access nodes in your Tailnet.
TAILSCALE\_AUTHKEY is an [authkey](https://tailscale.com/kb/1085/auth-keys/)
for the Tailnet to be accessed, and needs to be populated in the Secrets for
@ -18,18 +18,9 @@ your workflow. [Ephemeral authkeys](https://tailscale.com/kb/1111/ephemeral-node
to be a good fit for GitHub runners, as they clean up their state automatically shortly
after the runner finishes.
v1 of this Action uses [Tailscale client release 1.12.3](https://github.com/tailscale/tailscale/releases/tag/v1.12.3),
which can be overridden if desired with a version: field in the with: section.
----
### Maintainer's Notes
This repository is provided and maintained by Tailscale, Inc.
The CI script in this repository uses an ephemeral authkey generated for the
Tailnet owned by TailscaleGitHubActionBot.github. A new ephemeral authkey will
need to be generated every 3 months and placed in the TAILSCALE\_AUTHKEY in
the Secrets for this repository.
If a CI run fails, it is likely because the Ephemeral Authkey expired since
the last time it was run. You should generate a new key.
This repository is provided and maintained by Tailscale. The CI script in this
repository uses an ephemeral authkey generated for the Tailnet owned by
TailscaleGitHubActionBot.github and stored as a Secret as described above.