@@ -4,12 +4,12 @@ This GitHub Action connects to your [Tailscale network](https://tailscale.com)
44by adding a step to your workflow.
55
66``` yaml
7- - name : Tailscale
8- uses : tailscale/github-action@v4
9- with :
10- oauth-client-id : ${{ secrets.TS_OAUTH_CLIENT_ID }}
11- oauth-secret : ${{ secrets.TS_OAUTH_SECRET }}
12- tags : tag:ci
7+ - name : Tailscale
8+ uses : tailscale/github-action@v4
9+ with :
10+ oauth-client-id : ${{ secrets.TS_OAUTH_CLIENT_ID }}
11+ oauth-secret : ${{ secrets.TS_OAUTH_SECRET }}
12+ tags : tag:ci
1313` ` `
1414
1515Subsequent steps in the Action can then access nodes in your Tailnet.
@@ -32,8 +32,8 @@ on tailnets which use [Device Approval](https://tailscale.com/kb/1099/device-app
3232# # Eventual consistency
3333
3434Propagating information about new peers - such as the node created by this action - across your tailnet
35- is an eventually consistent process, and brief delays are expected. Until the GitHub workflow node
36- becomes visible, other peers will not accept connections. It is best to verify connectivity to the
35+ is an eventually consistent process, and brief delays are expected. Until the GitHub workflow node
36+ becomes visible, other peers will not accept connections. It is best to verify connectivity to the
3737intended nodes before executing steps that rely on them.
3838
3939You can do this by adding a list of hosts to ping to the action configuration :
@@ -60,45 +60,43 @@ The `ping` option will wait up to to 3 minutes for a connection (direct or relay
6060If you are using this Action in a [Tailnet
6161Lock](https://tailscale.com/kb/1226/tailnet-lock) enabled network, you need to :
6262
63- * Authenticate using an ephemeral reusable [pre-signed auth key](
64- https://tailscale.com/kb/1226/tailnet-lock#add-a-node-using-a-pre-signed-auth-key)
63+ - Authenticate using an ephemeral reusable [pre-signed auth key](https://tailscale.com/kb/1226/tailnet-lock#add-a-node-using-a-pre-signed-auth-key)
6564 rather than an OAuth client.
66- * Specify a [state directory](
67- https://tailscale.com/kb/1278/tailscaled#flags-to-tailscaled) for the
65+ - Specify a [state directory](https://tailscale.com/kb/1278/tailscaled#flags-to-tailscaled) for the
6866 client to store the Tailnet Key Authority data in.
6967
7068` ` ` yaml
71- - name: Tailscale
72- uses: tailscale/github-action@v4
73- with:
74- authkey: tskey-auth-...
75- statedir: /tmp/tailscale-state/
69+ - name: Tailscale
70+ uses: tailscale/github-action@v4
71+ with:
72+ authkey: tskey-auth-...
73+ statedir: /tmp/tailscale-state/
7674` ` `
7775
7876# # Defining Tailscale version
7977
8078Which Tailscale version to use can be set like this :
8179
8280` ` ` yaml
83- - name: Tailscale
84- uses: tailscale/github-action@v4
85- with:
86- oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
87- oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
88- tags: tag:ci
89- version: 1.52.0
81+ - name: Tailscale
82+ uses: tailscale/github-action@v4
83+ with:
84+ oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
85+ oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
86+ tags: tag:ci
87+ version: 1.52.0
9088` ` `
9189
9290If you'd like to specify the latest version, simply set the version as `latest`
9391
9492` ` ` yaml
95- - name: Tailscale
96- uses: tailscale/github-action@v4
97- with:
98- oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
99- oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
100- tags: tag:ci
101- version: latest
93+ - name: Tailscale
94+ uses: tailscale/github-action@v4
95+ with:
96+ oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
97+ oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
98+ tags: tag:ci
99+ version: latest
102100` ` `
103101
104102You can find the latest Tailscale stable version number at
@@ -116,10 +114,10 @@ As of v4 of this action, caching is enabled by default.
116114Although caching is generally recommended, you can disable it by passing `'false'` to the `use-cache` input :
117115
118116` ` ` yaml
119- - name: Tailscale
120- uses: tailscale/github-action@v4
121- with:
122- oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
123- oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
124- use-cache: ' false'
117+ - name: Tailscale
118+ uses: tailscale/github-action@v4
119+ with:
120+ oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
121+ oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
122+ use-cache: " false"
125123` ` `
0 commit comments