Skip to content

Commit 56dd519

Browse files
committed
chore: update the location of the requirements
1 parent 1006e80 commit 56dd519

File tree

4 files changed

+30
-18
lines changed

4 files changed

+30
-18
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,15 @@ and setup. Subsequent runs will be faster, but there are many tests, and some of
6565
them are slow. If you're working on a particular area of code, you can run just
6666
the tests in those directories instead, which can speed up your edit-run cycle.
6767

68+
## Updating tool dependencies
69+
70+
It's suggested to routinely update the tool versions within our repo - some of the
71+
tools are using requirement files compiled by `uv` and others us other means. In order
72+
to have everything self-documented, we have a special target -
73+
`//private:requirements.update`, which uses `rules_multirun` to run in sequence all
74+
of the requirement updating scripts in one go. This can be done once per release as
75+
we prepare for releases.
76+
6877
## Formatting
6978

7079
Starlark files should be formatted by

DEVELOPING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
1. Modify the `./python/private/pypi/requirements.txt` file and run:
66
```
7-
bazel run //tools/private/update_deps:update_pip_deps
7+
bazel run //private:requirements.update
88
```
99
1. Bump the coverage dependencies using the script using:
1010
```

private/BUILD.bazel

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
load("@rules_multirun//:defs.bzl", "multirun")
2+
3+
# This file has various targets that are using dev-only dependencies that our users should not ideally see.
4+
5+
multirun(
6+
name = "requirements.update",
7+
commands = [
8+
"//tools/publish:{}.update".format(r)
9+
for r in [
10+
"requirements_universal",
11+
"requirements",
12+
"requirements_darwin",
13+
"requirements_windows",
14+
"requirements_linux",
15+
]
16+
] + [
17+
"//docs:requirements.update",
18+
"//tools/private/update_deps:update_pip_deps",
19+
],
20+
)

tools/private/BUILD.bazel

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +0,0 @@
1-
load("@rules_multirun//:defs.bzl", "multirun")
2-
3-
multirun(
4-
name = "requirements.update",
5-
commands = [
6-
"//tools/publish:{}.update".format(r)
7-
for r in [
8-
"requirements_universal",
9-
"requirements",
10-
"requirements_darwin",
11-
"requirements_windows",
12-
"requirements_linux",
13-
]
14-
] + [
15-
"//docs:requirements.update",
16-
],
17-
)

0 commit comments

Comments
 (0)