Consider renaming action/repository to `tailnet-connect`, `tailscale-connect` or `setup-tailnet`

Open
  • Is something wrong?
#325 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
github, typescript
Domain
devtools

Research direction

Start by reading the repository description and the issue’s naming suggestions, then inspect the action metadata and documentation entry points to see where the current name is presented. The issue asks maintainers to consider a rename but does not settle on a name or define migration requirements; done would require an agreed naming decision and an implementation scope.

Written by the indexing model from the issue text.

Description

I would like to request that the tailscale team consider renaming this repository and action - my feeling is this would best be named tailnet-connect, tailscale-connect or setup-tailnet.

Thoughts:

  • my own experience when I saw tailscale/github-action used in a github action was "I don't know what this does" - does it connect to a tailnet or does it allow use of the API
  • my own feeling is that tailnet might have two different types of action - connect-tailnet and configure-tailscale-api - or maybe this is a single repository with a command that could either connect or get-api-token
  • a survey of other github actions reveals that most larger vendors utilize a "verb" in their action name - while I would not advocate for copying large vendors blindly, in this case it does seem sensible to at least look at larger vendors and see if there is a pattern that we like - I've asked an AI tool to do this:
┌──────────────────────────────────────┬─────────┬────────────┬────────────────────────────┬─────────┬─────────┬────────────────────────────────────────────────────────────────────────────────┐
│            Provider (org)            │ Actions │ Clear verb │ Including noun/verb words¹ │ No verb │ Generic │                                    Examples                                    │
├──────────────────────────────────────┼─────────┼────────────┼────────────────────────────┼─────────┼─────────┼────────────────────────────────────────────────────────────────────────────────┤
│ Google Cloud (google-github-actions) │ 12      │ 92%        │ 92%                        │ 8%      │ 0       │ setup-gcloud, get-gke-credentials, deploy-cloudrun                             │
├──────────────────────────────────────┼─────────┼────────────┼────────────────────────────┼─────────┼─────────┼────────────────────────────────────────────────────────────────────────────────┤
│ Oracle (oracle-actions)              │ 6       │ 83%        │ 100%                       │ 0%      │ 0       │ configure-kubectl-oke, login-ocir, run-oci-cli-command                         │
├──────────────────────────────────────┼─────────┼────────────┼────────────────────────────┼─────────┼─────────┼────────────────────────────────────────────────────────────────────────────────┤
│ AWS (aws-actions)                    │ 22      │ 55%        │ 73%                        │ 27%     │ 0       │ configure-aws-credentials, amazon-ecs-deploy-task-definition, amazon-ecr-login │
├──────────────────────────────────────┼─────────┼────────────┼────────────────────────────┼─────────┼─────────┼────────────────────────────────────────────────────────────────────────────────┤
│ Azure (Azure)                        │ 44      │ 48%        │ 64%                        │ 36%     │ 0       │ setup-kubectl, k8s-deploy, login                                               │
├──────────────────────────────────────┼─────────┼────────────┼────────────────────────────┼─────────┼─────────┼────────────────────────────────────────────────────────────────────────────────┤
│ Alibaba (aliyun)                     │ 5       │ 40%        │ 80%                        │ 20%     │ 0       │ configure-aliyun-credentials-action, acr-login                                 │
├──────────────────────────────────────┼─────────┼────────────┼────────────────────────────┼─────────┼─────────┼────────────────────────────────────────────────────────────────────────────────┤
│ IBM (IBM)                            │ 9       │ 22%        │ 22%                        │ 78%     │ 0       │ setup-python-pz, code-engine-github-action                                     │
├──────────────────────────────────────┼─────────┼────────────┼────────────────────────────┼─────────┼─────────┼────────────────────────────────────────────────────────────────────────────────┤
│ Total                                │ 98      │ 54%        │ 68%                        │ 32%     │ 0       │                                                                                │
└──────────────────────────────────────┴─────────┴────────────┴────────────────────────────┴─────────┴─────────┴────────────────────────────────────────────────────────────────────────────────┘```
Dominant language
TypeScript
Stars
964
Forks
145
Avg merge
18h 2m
Merged PRs (30d)
5

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tailscale/github-action

All issues in tailscale/github-action

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.