fix: improve permission error for provenance #6226
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Improves the error message returned when a user attempts to generate a provenance statement on publish but has not set the correct perissions in the GitHub Actions workflow. Signed-off-by: Brian DeHamer <bdehamer@github.com>
bdehamer
commented
Mar 7, 2023
| GITHUB_ACTIONS: false, | ||
| GITHUB_ACTIONS: undefined, |
There was a problem hiding this comment.
Turns out that setting this to false still causes ciInfo.name to evaluate to "GITHUB_ACTIONS". To properly simulate NOT running in GitHub Actions, this needs to be undefined.
There was a problem hiding this comment.
ah yes, I guess it would be very surprising if this env var was set to anything on some other platform?
lukekarrys
approved these changes
Mar 8, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improves the error message returned when a user attempts to generate a provenance statement on publish but has not set the correct perissions in the GitHub Actions workflow.
Improves the error messaging if the user attempts to publish a package w/ provenance but has NOT set the necessary token permissions to create an OIDC token.
Currently, if the user omits the
id-token: writepermission, the error message reads:This is potentially confusing given that it may actually be running in GitHub Actions, just with incorrect permissions.
This change separates the
CI == 'GitHub Actions'check from theACTIONS_ID_TOKEN_REQUEST_URLcheck so we can provide more specific error messages in the two cases.The new error message reads: