tailscale/github-action
1
0
Fork 0
mirror of https://github.com/tailscale/github-action.git synced 2026-08-21 12:09:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
96 commits 26 branches 19 tags 5.1 MiB
Find a file
Mario Minardi 8fe6f78f60
{.github/workflows,action.yml}: run windows in unattended mode 
Add the `--unattended` flag when running the action on windows-based
machines. This allows the action to properly connect on windows machines
that do not have full GUI support under the hood (e.g., for the current
batch of `windows-11-arm` runners).

Fixes https://github.com/tailscale/github-action/issues/180

Signed-off-by: Mario Minardi <mario@tailscale.com>
2025-06-23 10:07:15 -06:00
.github/workflows {.github/workflows,action.yml}: run windows in unattended mode 2025-06-23 10:07:15 -06:00
action.yml {.github/workflows,action.yml}: run windows in unattended mode 2025-06-23 10:07:15 -06:00
LICENSE create deployable GitHub action 2021-04-23 18:20:24 -04:00
README.md README.md: document the use-cache input 2025-04-09 10:48:25 -06:00

README.md

Tailscale GitHub Action

This GitHub Action connects to your Tailscale network by adding a step to your workflow.

  - name: Tailscale
    uses: tailscale/github-action@v3
    with:
      oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
      oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
      tags: tag:ci

Subsequent steps in the Action can then access nodes in your Tailnet.

oauth-client-id and oauth-secret are an OAuth client for the tailnet to be accessed. We recommend storing these as GitHub Encrypted Secrets. OAuth clients used for this purpose must have the auth_keys scope.

tags is a comma-separated list of one or more ACL Tags for the node. At least one tag is required: an OAuth client is not associated with any of the Users on the tailnet, it has to Tag its nodes.

Nodes created by this Action are marked as Ephemeral to be automatically removed by the coordination server a short time after they finish their run. The nodes are also marked Preapproved on tailnets which use Device Approval

Tailnet Lock

If you are using this Action in a Tailnet Lock enabled network, you need to:

  • Authenticate using an ephemeral reusable pre-signed auth key rather than an OAuth client.
  • Specify a state directory for the client to store the Tailnet Key Authority data in.
  - name: Tailscale
    uses: tailscale/github-action@v3
    with:
      authkey: tskey-auth-...
      statedir: /tmp/tailscale-state/

Defining Tailscale version

Which Tailscale version to use can be set like this:

  - name: Tailscale
    uses: tailscale/github-action@v3
    with:
      oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
      oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
      tags: tag:ci
      version: 1.52.0

If you'd like to specify the latest version, simply set the version as latest

  - name: Tailscale
    uses: tailscale/github-action@v3
    with:
      oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
      oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
      tags: tag:ci
      version: latest

You can find the latest Tailscale stable version number at https://pkgs.tailscale.com/stable/#static.

Cache Tailscale binaries

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.

You can opt in to caching Tailscale binaries by passing 'true' to the use-cache input:

  - name: Tailscale
    uses: tailscale/github-action@v3
    with:
      oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
      oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
      use-cache: 'true'