Skip to content

Commit b3333b3

Browse files
committed
Document optional auto jobs in the rustc-dev-guide
1 parent 96e4833 commit b3333b3

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

  • src/doc/rustc-dev-guide/src/tests

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,12 @@ The live results can be seen on [the GitHub Actions workflows page].
109109
At any given time, at most a single `auto` build is being executed.
110110
Find out more in [Merging PRs serially with bors](#merging-prs-serially-with-bors).
111111

112+
Normally, when an auto job fails, the whole CI workflow immediately ends. However, it can be useful to
113+
create auto jobs that are "non-blocking", or optional, to test them on CI for some time before blocking
114+
merges on them. This can be useful if those jobs can be flaky.
115+
116+
To do that, prefix such a job with `optional-`, and set `continue_on_error: true` for it in [`jobs.yml`].
117+
112118
[platform tiers]: https://forge.rust-lang.org/release/platform-support.html#rust-platform-support
113119
[auto]: https://github.com/rust-lang/rust/tree/automation/bors/auto
114120

0 commit comments

Comments
 (0)