Skip to content

Commit cc4acd6

Browse files
Add a note guiding users to include SBOM files in the source distribution (#2120)
* Add a note guiding users to include SBOM files in the source distribution * Remove mention of uv and build --------- Co-authored-by: Cary Hawkins <[email protected]>
1 parent 9068758 commit cc4acd6

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/plugins/builder/wheel.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ The builder plugin name is `wheel`.
2525
| `bypass-selection` | `false` | Whether or not to suppress the error when one has not defined any file selection options and all heuristics have failed to determine what to ship |
2626
| `sbom-files` | | A list of paths to [Software Bill of Materials](https://peps.python.org/pep-0770/) files that will be included in the `.dist-info/sboms/` directory of the wheel |
2727

28+
!!! note
29+
Many build frontends will build the wheel from a source distribution. This is the recommended approach, but it means you need to ensure the SBOM files passed to `sbom-files` are also [included in the source distribution](https://hatch.pypa.io/latest/config/build/#file-selection).
2830

2931
## Versions
3032

0 commit comments

Comments
 (0)