Skip to content

docs: fix typos and capitalization in README #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Avicennasis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix typos and capitalization in README #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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.