Skip to content

Commit 92e9032

Browse files
authored
docs: update provenance tutorial (#1110)
This PR updates the npm provenance discovery tutorial to include the newer discovery methods: PyPI and GitHub. The tutorial is updated to provide examples of provenance discovery for PyPI and GitHub using the toga PyPI library, which has provenance of either type available for discovery depending on the exact version specified. For GitHub attestation, a small code update is included to allow the repository URL and commit digest to be found from provenance. Also, the verify-provenance command line argument has been removed, making this action occur by default once again. Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
1 parent 8df2f50 commit 92e9032

File tree

38 files changed

+769
-541
lines changed

38 files changed

+769
-541
lines changed
36.8 KB
Loading
File renamed without changes.
60.6 KB
Loading
59.5 KB
Loading
60.2 KB
Loading
64.2 KB
Loading

docs/source/pages/tutorials/commit_finder.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,4 +164,4 @@ Future Work
164164

165165
Mapping artifact to commits within repositories is a challenging endeavour. Macron's Commit Finder feature relies on repositories having and using version tags in a sensible way (a tag is considered sensible if it closely matches the version it represents). An alternative, or complimentary, approach would be to make use of the information found within provenance files, where information such as the commit hash used to create the artifact can potentially be found. Additionally, it should be noted that the Commit Finder feature was modelled on the intentions of developers (in terms of tag usage) within a large quantity of Java projects. As tag formatting is "generally" language agnostic in the same way that versioning schemes are, this feature should work well for other languages. However, there may be some improvements to be made by further testing on a large number of non-Java projects.
166166

167-
.. note:: Macaron now supports extracting repository URLs and commit hashes from provenance files. This is demonstrated in a new tutorial: :doc:`npm_provenance </pages/tutorials/npm_provenance>`.
167+
.. note:: Macaron now supports extracting repository URLs and commit hashes from provenance files. This is demonstrated in a new tutorial: :doc:`provenance </pages/tutorials/provenance>`.

docs/source/pages/tutorials/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For the full list of supported technologies, such as CI services, registries, an
2020
commit_finder
2121
detect_malicious_package
2222
detect_vulnerable_github_actions
23-
npm_provenance
23+
provenance
2424
detect_malicious_java_dep
2525
generate_verification_summary_attestation
2626
use_verification_summary_attestation

docs/source/pages/tutorials/npm_provenance.rst

Lines changed: 0 additions & 168 deletions
This file was deleted.

0 commit comments

Comments
 (0)