Skip to content

Commit 6daf172

Browse files
authored
Update README to describe CI flags (#2877)
[skip tests]
1 parent dfaabdb commit 6daf172

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,3 +127,23 @@ channel of the [Julia Slack](https://julialang.org/community/).
127127

128128
Contributions are very welcome, as are feature requests and suggestions. Please open an
129129
[issue](https://github.com/JuliaGPU/CUDA.jl/issues) if you encounter any problems.
130+
131+
### Note for contributors about CI usage
132+
133+
You can pass special flags to Buildkite to avoid overburdening the GPU CI agents, which
134+
are a shared resource. The flag should be added to your top level commit message (**not**
135+
the extended message).
136+
137+
Available flags are:
138+
- `[only julia]`: test only on the various Julia versions CUDA.jl supports, skipping testing subpackages and the various CUDA toolkits
139+
- `[only tests]`: don't run the benchmark or documentation steps
140+
- `[only subpackages]`: skip all the Julia and CUDA toolkit version runs, only test `cuTENSOR`, `cuStateVec`, `cuTensorNet`, and `CUDNN`
141+
- `[only docs]`: only build the documentation, skip all tests and benchmarks
142+
- `[only special]`: only test the special cases of multi-GPU, the various default memory locations, compute sanitizer, and the GPU-less environment
143+
- `[only downstream]`: test only the "downstream" packages which depend on CUDA.jl and its libraries, such as Enzyme.jl
144+
- `[skip downstream]`: don't the "downstream" packages
145+
- `[skip special]`: don't run the above described special tests
146+
- `[skip tests]`: skip all tests, only run benchmarks and documentation
147+
- `[skip benchmarks]`: don't run the benchmarks
148+
149+
If you use these flags, make sure you don't exclude tests your changes could actually impact.

0 commit comments

Comments
 (0)