docs: update provenance tutorial #1110
Open
Conversation
This file contains hidden or 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
oracle-contributor-agreement
bot
added
the
OCA Verified
behnazh-w
reviewed
Jul 1, 2025
behnazh-w
reviewed
Jul 1, 2025
behnazh-w
reviewed
Jul 1, 2025
behnazh-w
reviewed
Jul 21, 2025
benmss
force-pushed
the
benmss/update-provenance-tutorial
branch
from
b246674 to
c665852
Compare
…ub attestation Signed-off-by: Ben Selwyn-Smith <[email protected]>
Signed-off-by: Ben Selwyn-Smith <[email protected]>
…test as tutorial; update tutorial wording; include tutorial sections for CI and local provenance; add input attestation predicate and build types Signed-off-by: Ben Selwyn-Smith <[email protected]>
Signed-off-by: Ben Selwyn-Smith <[email protected]>
…rify-provenance option Signed-off-by: Ben Selwyn-Smith <[email protected]>
Signed-off-by: Ben Selwyn-Smith <[email protected]>
benmss
force-pushed
the
benmss/update-provenance-tutorial
branch
from
b98767a to
cf97722
Compare
Signed-off-by: Ben Selwyn-Smith <[email protected]>
Signed-off-by: Ben Selwyn-Smith <[email protected]>
Signed-off-by: Ben Selwyn-Smith <[email protected]>
Signed-off-by: Ben Selwyn-Smith <[email protected]>
behnazh-w
reviewed
Aug 18, 2025
| :alt: HTML report for ``toga 0.4.8``, summary | ||
| :align: center | ||
|
|
||
| This image shows that both checks have passed, confirming that the repository URL and commit digest from the provenance match those associated with the user provided PURL. To access the full report use the following: |
There was a problem hiding this comment.
Suggested change
| This image shows that both checks have passed, confirming that the repository URL and commit digest from the provenance match those associated with the user provided PURL. To access the full report use the following: | |
| This image shows that all three checks have passed, confirming that the repository URL and commit digest from the provenance match those associated with the user provided PURL. To access the full report use the following command: |
|
|
||
| ./run_macaron.sh analyze -purl pkg:pypi/[email protected] | ||
|
|
||
| As part of this analysis, Macaron ends up downloading three different asset files: The `attestation asset <https://api.github.com/repos/urllib3/urllib3/releases/assets/84708804>`_, the artifact's Python wheel file, and the artifact's compressed archive. By examining the attestation, Macaron can verify the two other files. This analysis can then report that provenance exists, and is verified. |
There was a problem hiding this comment.
Suggested change
| As part of this analysis, Macaron ends up downloading three different asset files: The `attestation asset <https://api.github.com/repos/urllib3/urllib3/releases/assets/84708804>`_, the artifact's Python wheel file, and the artifact's compressed archive. By examining the attestation, Macaron can verify the two other files. This analysis can then report that provenance exists, and is verified. | |
| As part of this analysis, Macaron ends up downloading three different asset files: The `attestation asset <https://api.github.com/repos/urllib3/urllib3/releases/assets/84708804>`_, the artifact's Python wheel file, and the source distribution tarball file. By examining the attestation, Macaron can verify the two other files. This analysis can then report that provenance exists, and is verified. |
| Supported Attestation Types | ||
| *************************** | ||
|
|
||
| When attestation is provided to Macaron as input, it must be of one of the support types in order to be accepted. Support is defined by the ``predicateType`` and ``buildType`` properties within an attestation. |
There was a problem hiding this comment.
Suggested change
| When attestation is provided to Macaron as input, it must be of one of the support types in order to be accepted. Support is defined by the ``predicateType`` and ``buildType`` properties within an attestation. | |
| When attestation is provided to Macaron as input, it must be of one of the supported types in order to be accepted. Support is defined by the ``predicateType`` and ``buildType`` properties within an attestation. |
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.
Summary
This PR updates the npm provenance discovery tutorial to include the newer discovery methods: PyPI and GitHub.
Description of changes
togaPyPI library, which has provenance of either type available for discovery depending on the exact version specified.7.7.2Removal of
verify-provenanceand Download ChangesAs part of this PR, the
verify-provenancecommand line argument has been removed, making this action occur by default once again. This command was originally introduced due to concerns about downloading overly large files, thereby slowing down analyses. Instead of this, a file size limit has been imposed for download operations that were previously using theStreamfunctionality.In cases where the size is not known before the download begins (most cases), the download will terminate when the streamed data exceeds the limit. This limit can be configured in the
defaults.iniand defaults to10mb. This is not sufficient for two of our existing integration tests and they have been adjusted accordingly.