docs: recommend base64-subjects-as-file for masked outputs issue #2434
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
behnazh-w
requested review from
asraa,
ianlewis,
laurentsimon and
joshuagl
as code owners
ianlewis
approved these changes
Jul 21, 2023
internal/builders/generic/README.md
Outdated
| @@ -98,7 +98,7 @@ provenance: | |||
| base64-subjects: "${{ needs.build.outputs.hashes }}" | |||
| ``` | |||
|
|
|||
| The `base64-subjects` input has a maximum length as defined by [ARG_MAX](https://www.in-ulm.de/~mascheck/various/argmax/) on the runner. If you need to attest to a large number of files that exceeds the maximum length, use the `base64-subjects-as-file` input option instead. This option requires that you save the ouput of the sha256sum command into a file: | |||
| The `base64-subjects` input has a maximum length as defined by [ARG_MAX](https://www.in-ulm.de/~mascheck/various/argmax/) on the runner. If you need to attest to a large number of files that exceeds the maximum length, use the `base64-subjects-as-file` input option instead. Another usecase for this option is when GitHub Actions runner masks the job output because it detects a secret (see the discussion [here](https:/orgs/community/discussions/37942)). This option requires that you save the output of the sha256sum command into a file: | |||
There was a problem hiding this comment.
Suggested change
| The `base64-subjects` input has a maximum length as defined by [ARG_MAX](https://www.in-ulm.de/~mascheck/various/argmax/) on the runner. If you need to attest to a large number of files that exceeds the maximum length, use the `base64-subjects-as-file` input option instead. Another usecase for this option is when GitHub Actions runner masks the job output because it detects a secret (see the discussion [here](https:/orgs/community/discussions/37942)). This option requires that you save the output of the sha256sum command into a file: | |
| The `base64-subjects` input has a maximum length as defined by [ARG_MAX](https://www.in-ulm.de/~mascheck/various/argmax/) on the runner. If you need to attest to a large number of files that exceeds the maximum length, use the `base64-subjects-as-file` input option instead. Another use case for this option is when GitHub Actions runner masks the job output because it detects a secret (see the discussion [here](https:/orgs/community/discussions/37942)). This option requires that you save the output of the sha256sum command into a file: |
There was a problem hiding this comment.
I think we could also add an entry to the "Known Issues" section for issue masking that recommends this solution.
There was a problem hiding this comment.
Added in commit 4eacceb.
behnazh-w
force-pushed
the
behnazh/generic-docs
branch
2 times, most recently
from
3c5f5c9
to
4eacceb
Compare
laurentsimon
approved these changes
Jul 21, 2023
|
Can you rebase? |
The GitHub Actions runner sometimes masks the job output if it potentially contains an accessible secret. The new `base64-subjects-as-file` feature can be recommended to pass the artifact hashes using an existing file and bypass the job output masking issue. See this discussion: https:/orgs/community/discussions/37942 Signed-off-by: behnazh-w <[email protected]>
auto-merge was automatically disabled
July 22, 2023 06:02
Head branch was pushed to by a user without write access
behnazh-w
force-pushed
the
behnazh/generic-docs
branch
from
0a6508c
to
37e70c2
Compare
enteraga6
pushed a commit
to enteraga6/slsa-github-generator
that referenced
this pull request
Aug 8, 2023
…a-framework#2434) The GitHub Actions runner sometimes masks the job output if it potentially contains an accessible secret. The new `base64-subjects-as-file` feature can be recommended to pass the artifact hashes using an existing file and bypass the job output masking issue. See this discussion: https:/orgs/community/discussions/37942 Signed-off-by: behnazh-w <[email protected]> Signed-off-by: Noah Elzner <[email protected]>
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.
The GitHub Actions runner sometimes masks the job output if it potentially contains an accessible secret. The new
base64-subjects-as-filefeature can be recommended to pass the artifact hashes using an existing file and bypass the job output masking issue.See this discussion: https:/orgs/community/discussions/37942