11# Crater
22
3- [ Crater] ( https://github.com/rust-lang/crater ) is a tool for compiling
4- and running tests for _ every_ crate on [ crates.io] ( https://crates.io ) (and a
5- few on GitHub). It is mainly used for checking the extent of breakage when
6- implementing potentially breaking changes and ensuring lack of breakage by
7- running beta vs stable compiler versions.
3+ [ Crater] ( https://github.com/rust-lang/crater ) is a tool for compiling and
4+ running tests for _ every_ crate on [ crates.io] ( https://crates.io ) (and a few on
5+ GitHub). It is mainly used for checking the extent of breakage when implementing
6+ potentially breaking changes and ensuring lack of breakage by running beta vs
7+ stable compiler versions.
88
99## When to run Crater
1010
@@ -15,16 +15,16 @@ or could cause breakage. If you are unsure, feel free to ask your PR's reviewer.
1515
1616The rust team maintains a few machines that can be used for running crater runs
1717on the changes introduced by a PR. If your PR needs a crater run, leave a
18- comment for the triage team in the PR thread. Please inform the team whether
19- you require a "check-only" crater run, a "build only" crater run, or a
18+ comment for the triage team in the PR thread. Please inform the team whether you
19+ require a "check-only" crater run, a "build only" crater run, or a
2020"build-and-test" crater run. The difference is primarily in time; the
21- conservative (if you're not sure) option is to go for the build-and-test run.
22- If making changes that will only have an effect at compile-time (e.g.,
23- implementing a new trait) then you only need a check run.
21+ conservative (if you're not sure) option is to go for the build-and-test run. If
22+ making changes that will only have an effect at compile-time (e.g., implementing
23+ a new trait) then you only need a check run.
2424
2525Your PR will be enqueued by the triage team and the results will be posted when
26- they are ready. Check runs will take around ~ 3-4 days, with the other two
27- taking 5-6 days on average.
26+ they are ready. Check runs will take around ~ 3-4 days, with the other two taking
27+ 5-6 days on average.
2828
2929While crater is really useful, it is also important to be aware of a few
3030caveats:
@@ -37,9 +37,9 @@ caveats:
3737- Crater only runs Linux builds on x86_64. Thus, other architectures and
3838 platforms are not tested. Critically, this includes Windows.
3939
40- - Many crates are not tested. This could be for a lot of reasons, including
41- that the crate doesn't compile any more (e.g. used old nightly features),
42- has broken or flaky tests, requires network access, or other reasons.
40+ - Many crates are not tested. This could be for a lot of reasons, including that
41+ the crate doesn't compile any more (e.g. used old nightly features), has
42+ broken or flaky tests, requires network access, or other reasons.
4343
4444- Before crater can be run, ` @bors try ` needs to succeed in building artifacts.
4545 This means that if your code doesn't compile, you cannot run crater.
0 commit comments