Skip to content

Commit 4f9bb8c

Browse files
committed
Mention fast try builds in the rustc-dev-guide
1 parent 082777e commit 4f9bb8c

File tree

1 file changed

+10
-6
lines changed
  • src/doc/rustc-dev-guide/src/tests

1 file changed

+10
-6
lines changed

src/doc/rustc-dev-guide/src/tests/ci.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -135,12 +135,16 @@ There are several use-cases for try builds:
135135
- Run a specific CI job (e.g. Windows tests) on a PR, to quickly test if it
136136
passes the test suite executed by that job.
137137

138-
You can select which CI jobs will
139-
be executed in the try build by adding lines containing `try-job:
140-
<job pattern>` to the PR description. All such specified jobs will be executed
141-
in the try build once the `@bors try` command is used on the PR. If no try
142-
jobs are specified in this way, the jobs defined in the `try` section of
143-
[`jobs.yml`] will be executed by default.
138+
By default, if you send a comment with `@bors try`, the jobs defined in the `try` section of
139+
[`jobs.yml`] will be executed. We call this mode a "fast try build". Such a try build
140+
will not execute any tests, and it will allow compilation warnings. It is useful when you want to
141+
get an optimized toolchain as fast as possible, for a crater run or performance benchmarks,
142+
even if it might not be working fully correctly.
143+
144+
If you want to run a custom CI job in a try build and make sure that it passes all tests and does
145+
not produce any compilation warnings, you can select CI jobs to be executed by adding lines
146+
containing `try-job: <job pattern>` to the PR description. All such specified jobs will be executed
147+
in the try build once the `@bors try` command is used on the PR.
144148

145149
Each pattern can either be an exact name of a job or a glob pattern that matches multiple jobs,
146150
for example `*msvc*` or `*-alt`. You can start at most 20 jobs in a single try build. When using

0 commit comments

Comments
 (0)