support for headers param in attest functions #1790
Merged
+26
−6
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
bdehamer
force-pushed
the
bdehamer/attest-headers
branch
from
918b285 to
d063821
Compare
| @@ -28,6 +28,8 @@ export type AttestOptions = { | |||
| // Sigstore instance to use for signing. Must be one of "public-good" or | |||
| // "github". | |||
| sigstore?: SigstoreInstance | |||
| // HTTP headers to include in request to attestations API. | |||
| headers?: {[header: string]: string | number | undefined} | |||
There was a problem hiding this comment.
Should we have a block list to make sure the client does not set a header that may interfere with any standard headers that are sent?
There was a problem hiding this comment.
I looked into this and everything we'd maybe want to block (user-agent, accept, content-type, authorization) is already overridden in the @octokit/request library. I think we're good to pass-along whatever and let octokit sort it out.
Signed-off-by: Brian DeHamer <bdehamer@github.com>
bdehamer
force-pushed
the
bdehamer/attest-headers
branch
from
d063821 to
340a103
Compare
kommendorkapten
approved these changes
Aug 16, 2024
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.
Updates the
attestandattestProvenancefunctions to accept a new, optionalheadersparameter.If supplied, any headers will be passed-along to the GH attestations API in addition to the required auth header.