tailscale / tailscale/github-action

new typescript actions creates artifacts in repo

Open
#233 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
938
Forks
137
PR merge metrics
No merged PRs in 30d

Description

The new typescript action creates artifacts in the local repo, the tailscale.tgz and tailscaled.pid files. In most cases, that's probably not a big deal, but for actions that are updating files in the local repo and then opening PRs, those files get included in the PR. For example, our internal http://go/golink-snapshot action. For now, I've added those to our .gitignore file, which is fine, but it might be nice to store those elsewhere if possible?

If you want to be really pedantic about it, tailscale.tgz should probably be put in XDG_CACHE_HOME (default: ~/.cache) and tailscaled.pid should be in XDG_RUNTIME_DIR, which I don't think has a canonical default. On my system, it's set to /run/user/1000, but that might be an arch thing. We might need to experiment with what gets set on action runners, or just simply putting it in ~/.cache too would likely be fine.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by tracing the TypeScript action's creation of tailscale.tgz and tailscaled.pid, then inspect the repository .gitignore and the action runner's available XDG directories. Determine a suitable location outside the local repository for both artifacts, and verify that an action updating files can open a PR without including them.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, typescript
Domain
ci-cd
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.