8000 docs(compile_pip_requirements): Add note on requirements.txt VC (#1245) · chrislovecnm/rules_python@7f6de72 · GitHub
[go: up one dir, main page]
Skip to content

Commit 7f6de72

Browse files
boomanaiden154boomanaiden154
authored
docs(compile_pip_requirements): Add note on requirements.txt VC (bazel-contrib#1245)
The documentation is currently ambiguous on whether or not to check requirements.txt into version control. This has raised some confusion in other projects (e.g., google/gematria#3). This makes it clear that requirements.txt files produced by this rule should be checked into version control in an easy to find place to avoid confusion.
1 parent 148622a commit 7f6de72

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

‎docs/pip.md

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎python/pip_install/requirements.bzl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ def compile_pip_requirements(
4242
- validate with `bazel test [name]_test`
4343
- update with `bazel run [name].update`
4444
45+
If you are using a version control system, the requirements.txt generated by this rule should
46+
be checked into it to ensure that all developers/users have the same dependency versions.
47+
4548
Args:
4649
name: base name for generated targets, typically "requirements".
4750
extra_args: passed to pip-compile.

0 commit comments

Comments
 (0)
0