Repository navigation
✨ feat: add PEP 770 SBOM build hook - #1
Merged
Merged
Conversation
Port the CycloneDX SBOM generator from pypa/virtualenv's hatch_build.py into a reusable hatchling plugin, with the project-specific parts (supplier, repository, bundled wheels) moved into hook options and a subclass method for per-wheel properties. The SPDX rendering and the validator ship as the hatch-pep770 spdx and validate commands.
|
You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool. What Enabling Code Scanning Means:
For more information about GitHub Code Scanning, check out the documentation. |
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
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.
This adds
hatch-pep770, a hatchling build hook that writes a CycloneDX 1.6 SBOM into each wheel at.dist-info/sboms/<name>.cdx.json, as PEP 770 describes. It is the generator from pypa/virtualenv'shatch_build.py, made reusable so the other hatchling projects can enable it with one table inpyproject.toml.The SBOM records the project from its core metadata, the declared runtime dependencies, any wheels the project bundles as data files (with hashes, files and vendored packages), and the build toolchain. Nothing about the build machine goes in, and the timestamp comes from
SOURCE_DATE_EPOCH, so rebuilding a tag reproduces the wheel byte for byte.The virtualenv-specific parts became options (
supplier,repository,default-branch,bundled-wheels) plus abundled_wheel_propertiesmethod a custom build hook can override. Built through this package, virtualenv's wheel SBOM matches its current one except for the build-script hash, the serial number, andhatch-pep770showing up among the build tools. The SPDX rendering and the validator ship ashatch-pep770 spdxandhatch-pep770 validate; the latter needs thevalidateextra.The floor is Python 3.9 because virtualenv still builds there. On 3.9 hatchling stops at 1.27, which cannot embed an SBOM, so the hook prints a warning and skips it.