tailscale / github-action

A GitHub Action to connect your workflow to your Tailscale network.
BSD 3-Clause "New" or "Revised" License
519 stars 78 forks source link

Speed bumps along the way to getting this action working #114

Open davewsmith opened 4 months ago

davewsmith commented 4 months ago

Users who've found the blog post that introduces GitHub actions but who've yet to encounter a need to tag devices may find themselves frustrated when trying to use this action. Failure messages along the way are cryptic, and the README doesn't offer guidance.

A naive attempt with a completely de-fanged Oauth client will produce

"user does not have access to this operation"

which means, without saying so directly, that the oath client needs to have granted write permission to Devices. Then

"requested tags [tag:ci] are invalid or not permitted"

means, without saying so directly, that the policy file hasn't included tags:ci in tagOwners:.

Mentioning these in the README may save future users frustration.