Fix incorrect documentation about the token input to the Actions.#2477
Fix incorrect documentation about the token input to the Actions.#2477chrisgavin merged 3 commits intomainfrom
token input to the Actions.#2477Conversation
aeisenberg
left a comment
There was a problem hiding this comment.
I think security-events is required.
|
I wonder if we should also include the guidance that it's best to avoid using this input and so the workflow falls back to using the actions-provided token. |
Co-authored-by: Andrew Eisenberg <aeisenberg@github.com>
|
That might make sense, though I'm not sure how exactly to phrase it. There are some pretty specific situations where it is useful to be able to set these inputs, but in general they probably shouldn't be used. |
|
What do you think of this?
If you need to specify the input, you will be an advanced user anyway, so I don't think this would be confusing. |
|
This is very confusing since the underlying api clearly says it's possible: Oh well, at least the documentation now warns that this doesn't work. I'd almost suggest that the description should say:
|
This documentation is currently misleading as it implies you can use any token here. In reality, this Action calls API endpoints that only accept tokens from the GitHub Actions app, so you should basically never override it.
I believe all the other Actions in this repository will work with an arbitrary token if one needs to be provided for cross-repository access, but these two call the SARIF upload endpoint which requires an Actions token.