Skip to content

Commit 934768c

Browse files
docs: Add warning about hermetic builds with pyproject.toml
1 parent 0ff0597 commit 934768c

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/pypi-dependencies.md

+6
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ For more documentation, see the API docs under {obj}`@rules_python//python:pip.b
3434

3535
Once you generate this fully specified list of requirements, you can install the requirements with the instructions in [Installing third party packages](#installing-third-party-packages).
3636

37+
```{warning}
38+
If you're specifying dependencies in `pyproject.toml`, make sure to include the `[build-system]` configuration, with pinned dependencies. `compile_pip_requirements` will use the build system specified to read your project's metadata, and you might see non-hermetic behavior if you don't pin the build system.
39+
40+
Not specifying `[build-system]` at all will result in using a default `[build-system]` configuration, which uses unpinned versions ([ref](https://peps.python.org/pep-0518/#build-system-table)).
41+
```
42+
3743
{#installing-third-party-packages}
3844
## Installing third party packages
3945

0 commit comments

Comments
 (0)