Skip to content

Commit 3e4f509

Browse files
Document crate selections available with craterbot
1 parent 560e900 commit 3e4f509

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/bot-usage.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,29 @@ The mode you should use depends on what your experiment is testing:
8787

8888
[Go back to the TOC][h-toc]
8989

90+
## Available crate selections
91+
92+
By default, your experiment will be run on all crates known to Crater.
93+
However, it is possible to run an experiment on a subset of the ecosystem by
94+
passing a different value to `crates`. The following options are currently
95+
available:
96+
97+
* `full`: run the experiment on every crate.
98+
* `top-{n}`: run the experiment on the `n` most downloaded crates on
99+
[crates.io](crates.io) (e.g. `top-100`).
100+
* `random-{n}`: run the experiment on `n` randomly selected crates (e.g. `random-20`).
101+
* `list:{...}`: run the experiment on the specified crates.
102+
103+
For `list:`, the value after the colon can either be a comma-separated list of
104+
crates to run or a link to a newline-separated list of crates ([example][list]).
105+
For example, `list:lazy_static,brson/hello-rs` and `list:https://git.io/Jes7o`
106+
will both run an experiment on the `lazy_static` crate and the git repo at
107+
`github.com/brson/hello-rs`. A link must begin with `http[s]://`.
108+
109+
[list]: https://gist.githubusercontent.com/ecstatic-morse/837c558b63fc73ab469bfbf4ad419a1f/raw/example-crate-list
110+
111+
[Go back to the TOC][h-toc]
112+
90113
## Automatic experiment names
91114

92115
[h-experiment-names]: #automatic-experiment-names

0 commit comments

Comments
 (0)