about summary refs log tree commit diff
path: root/src/ci/github-actions
diff options
context:
space:
mode:
authorJieyou Xu <jieyouxu@outlook.com>2025-07-21 15:20:35 +0800
committerJieyou Xu <jieyouxu@outlook.com>2025-07-21 18:06:07 +0800
commit523594d7aec3293c6f1926e4f1edcec141ef496b (patch)
tree2f78a073bb8f5cba461386080da74369a505f7be /src/ci/github-actions
parentfc4bf03a81592b112abfd7274606af1c6919c3f6 (diff)
downloadrust-523594d7aec3293c6f1926e4f1edcec141ef496b.tar.gz
rust-523594d7aec3293c6f1926e4f1edcec141ef496b.zip
Update `jobs.yml` docs to reflect subset-modulo-carve-outs relationship
Diffstat (limited to 'src/ci/github-actions')
-rw-r--r--src/ci/github-actions/jobs.yml25
1 files changed, 19 insertions, 6 deletions
diff --git a/src/ci/github-actions/jobs.yml b/src/ci/github-actions/jobs.yml
index 0a6ebe44b3d..011688487b4 100644
--- a/src/ci/github-actions/jobs.yml
+++ b/src/ci/github-actions/jobs.yml
@@ -124,9 +124,16 @@ jobs:
     <<: *job-linux-36c-codebuild
 
 
-# Jobs that run on each push to a pull request (PR)
-# These jobs automatically inherit envs.pr, to avoid repeating
-# it in each job definition.
+# Jobs that run on each push to a pull request (PR).
+#
+# These jobs automatically inherit envs.pr, to avoid repeating it in each job
+# definition.
+#
+# PR CI jobs will be automatically registered as Auto CI jobs or overriden. When
+# automatically registered, the PR CI job configuration will be copied as an
+# Auto CI job but with `continue_on_error` overriden to `false` (to fail-fast).
+# When overriden, `citool` will check for equivalence between the PR and CI job
+# of the same name modulo `continue_on_error` and `env`.
 pr:
   - name: pr-check-1
     <<: *job-linux-4c
@@ -177,9 +184,15 @@ optional:
       IMAGE: pr-check-1
     <<: *job-linux-4c
 
-# Main CI jobs that have to be green to merge a commit into master
-# These jobs automatically inherit envs.auto, to avoid repeating
-# it in each job definition.
+# Main CI jobs that have to be green to merge a commit into master.
+#
+# These jobs automatically inherit envs.auto, to avoid repeating it in each job
+# definition.
+#
+# Auto jobs may not specify `continue_on_error: true`, and thus will fail-fast.
+#
+# Unless explicitly overriden, PR CI jobs will be automatically registered as
+# Auto CI jobs.
 auto:
   #############################
   #   Linux/Docker builders   #