From 982025d41b8631039613d8468efe817ca78baccb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9on=20=22Avic=22=20Simmons?= Date: Sat, 6 Jun 2026 02:13:44 -0400 Subject: [PATCH] docs: fix typos, capitalization, and French-influenced spelling in README --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2a0ad3c..9bb6006 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # tailscale-action -Hugging Face Github action to connect to tailscale (Based from https://github.com/tailscale/github-action) +Hugging Face GitHub Action to connect to Tailscale (Based on https://github.com/tailscale/github-action) -You can use this github action for 2 differents use cases : -- Access to internal shared ressources (like registry) +You can use this GitHub Action for 2 different use cases: +- Access to internal shared resources (like registry) - Log in SSH on the runner in order to debug the workflow -In the first case, you can also configure Tailscale to automatically start SSH server in case of job failure +In the first case, you can also configure Tailscale to automatically start an SSH server in case of job failure -# Access to internal shared ressources (like registry) +# Access to internal shared resources (like registry) Ask for the TAILSCALE_AUTHKEY secret and add this step to your workflow. @@ -17,8 +17,8 @@ Ask for the TAILSCALE_AUTHKEY secret and add this step to your workflow. authkey: ${{ secrets.TAILSCALE_AUTHKEY }} ``` -You can configure This Tailscale Action to run dynamically an SSH server on your runner if a step failed, or if you started your job with debug mode. -In this case, you have to add 2 inputs for slack notification and add a "wait" step at the end of your job +You can configure this Tailscale Action to run dynamically an SSH server on your runner if a step failed, or if you started your job with debug mode. +In this case, you have to add 2 inputs for Slack notification and add a "wait" step at the end of your job ```yaml - name: Tailscale @@ -41,7 +41,7 @@ In this case, you have to add 2 inputs for slack notification and add a "wait" s - Add this step at the end of your job (`TAILSCALE_SSH_AUTHKEY`, `SLACK_CIFEEDBACK_CHANNEL`, `SLACK_CIFEEDBACK_BOT_TOKEN` already available on all repos) -- Re-Run your Job with `Enable debug logging` on the github popup +- Re-Run your Job with `Enable debug logging` on the GitHub popup - Join the slack channel #github-runners, you will receive a slack message. ```yaml @@ -77,6 +77,6 @@ Tooltip : If you want to connect to the runner at the start of your workflow, to waitForSSH: true ``` -## Others options +## Other options - `sshTimeout` : by default Tailscale is waiting 5 minutes before terminating the job. You can increase this time.