-
Notifications
You must be signed in to change notification settings - Fork 59.5k
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.
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
Improve token-id
permission options
#26481
Comments
Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
This commit fixes a bug that is present when the `read` option is used for the `id-token` permission (see github/docs#26481).
This commit fixes a bug that is present when the `read` option is used for the `id-token` permission (see github/docs#26481).
This commit fixes a bug that is present when the `read` option is used for the `id-token` permission (see github/docs#26481).
@rickstaa Thanks so much for opening an issue! I'll triage this for the team to take a look 👀 And welcome to the community! 🎉 While this is awaiting review, help wanted section if you are looking for other ways to contribute. ✨ |
@rickstaa Also, if this is blocking you, please reach out to our awesome support team for additional help. And thanks again for the issue and for so clearly defining your problem 💖 |
@cmwilson21, thanks for your quick response. Take your time; it's not blocking since people can set |
FWIW, I had the same question today. I'm assuming the |
This commit fixes a bug that is present when the `read` option is used for the `id-token` permission (see github/docs#26481).
The `id-token` permission does actually not accept the value `read`. See github/docs#26481.
This comment was marked as spam.
This comment was marked as spam.
The `id-token` permission does actually not accept the value `read`. See github/docs#26481.
The `id-token` permission does actually not accept the value `read`. See github/docs#26481.
The `id-token` permission does actually not accept the value `read`. See github/docs#26481.
This commit fixes a bug that is present when the `read` option is used for the `id-token` permission (see github/docs#26481).
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀 |
there is also a reference to seeing |
This comment was marked as spam.
This comment was marked as spam.
1 similar comment
This comment was marked as spam.
This comment was marked as spam.
This is a gentle bump for the docs team that this issue is waiting for technical review. |
This commit fixes a bug that is present when the `read` option is used for the `id-token` permission (see github/docs#26481).
This is still incredibly confusing. |
Super confusing;) @rickstaa To quote from another thread:
So for me that means, that the (But with completely basic docs on what the id-token values really mean missing, I can't really make the mental model of what "read" and "to be safe and restrictive" really means in the context, how that differs from "none", probably without seeing some internals of how that is being used in the runners I won't be able to wrap my head around how that works and unfortunately just keep cargo-culting their use as directed by the actions' authors;)…) |
Code of Conduct
What article on docs.github.com is affected?
The options that can be used for the
token-id
permission are not documented. The documentation states that this key can take on the following values:write
: Allows a JWT token to be requested from GitHub's OIDC provider and (temporarily) written to the GitHub backend.read
: This option is unclear and looks deprecated.none
: Functions similarly to the (deprecated)read
option.However, when setting the
token-id
toread,
a github action fails with anUnexpected value 'read'
error. When thewrite
ornone
options are used, the workflow has no error. It, therefore, looks as if:read
option was deprecated, but the documentation is not yet updated.Since I don't know which of these two is correct, I did not yet create a PR to fix the documentation but decided to wait for the @github team to clarify this.
How to reproduce
To see this problem in action, go to this example repository and check the latest action runs:
What part(s) of the article would you like updated?
id-token
key in https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#overview should be updated from:to
read
option should also be removed from https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#adding-permissions-settings.Additional information
This issue is related but slightly different than #25952.
The text was updated successfully, but these errors were encountered: