Add a bit about crater #151
Conversation
Mark-Simulacrum
left a comment
Mark-Simulacrum
left a comment
There was a problem hiding this comment.
Thank you so much for writing this up!
src/tests/intro.md
Outdated
|
|
||
| TODO | ||
| [Crater](https://github.com/rust-lang-nursery/crater) is a tool for compiling | ||
| and running tests for _every_ crate on [crates.io](https://crates.io/). It is |
There was a problem hiding this comment.
and also many crates from GitHub... I'm not exactly sure what the search parameters are, but I know we at least try.
src/tests/intro.md
Outdated
| [Crater](https://github.com/rust-lang-nursery/crater) is a tool for compiling | ||
| and running tests for _every_ crate on [crates.io](https://crates.io/). It is | ||
| mainly used for checking for extent of breakage when implementing potentially | ||
| breaking changes. |
There was a problem hiding this comment.
and ensuring lack of breakage by running beta vs. stable "builds."
src/tests/intro.md
Outdated
| on the changes introduced by a PR. If your PR needs a crater run, leave a | ||
| comment for the triage team in the PR thread. Your will be enqueued by the | ||
| triage team and the results will be posted when they are ready. A crater run | ||
| usually takes a few days (as of this writing). |
There was a problem hiding this comment.
Please inform the team whether you require a "check-only" crater run, a "build only" crater run, or a "build-and-test" crater run. The difference is primarily in time; the conservative (if you're not sure) option is to go for the build-and-test run. If making changes that will only have an effect at compile-time (e.g., implementing a new trait) then you only need a check run.
Check runs will take around ~3-4 days, with the other two taking 5-6 days on average.
src/tests/intro.md
Outdated
| successful crater run is not a magically green light that there will be no | ||
| breakage; you still need to be careful. | ||
|
|
||
| - Crater only runs Linux builds (on x86_64, I believe). Thus, other |
There was a problem hiding this comment.
Yes, we only test / compile for x86_64-unknown-linux-gnu.
|
@Mark-Simulacrum Thanks for the feedback! I basically copy/pasted what you wrote :) Also I added
|
src/tests/intro.md
Outdated
| has broken or flaky tests, requires network access, or other reasons. | ||
|
|
||
| - Before crater can be run, `@bors try` needs to suceed. This means that if | ||
| your code doesn't compile or fails tests, you cannot run crater. |
There was a problem hiding this comment.
Failing tests is currently acceptable (we don't run them); we just need the code to compile on x86_64-unknown-linux-gnu.
src/tests/intro.md
Outdated
| that the crate doesn't compile any more (e.g. used old nightly features), | ||
| has broken or flaky tests, requires network access, or other reasons. | ||
|
|
||
| - Before crater can be run, `@bors try` needs to suceed in building artifacts. |
Mark-Simulacrum
left a comment
Mark-Simulacrum
left a comment
There was a problem hiding this comment.
If you want to squash and merge (not sure what the process here is), I'm happy with the changes.
|
Thanks! |
2 participants
closes #10
r? @Mark-Simulacrum