chore: nicer pr check docs

axodotdev · Sep 27, 2023 · 3367bd8 · 3367bd8
1 parent 8cee192
commit 3367bd8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/book/src/img/pr-fail.png b/book/src/img/pr-fail.png
diff --git a/book/src/introduction.md b/book/src/introduction.md
@@ -70,8 +70,12 @@ Most of the scripts roughly amount to "install cargo-dist", "run it exactly once
 
 Of course even if we perfectly achieve this ideal, "you *can* run it locally" and "you *want to* run it locally" are different statements.
 
+## Check Your Release Process Early And Often
+
 To that point, **release.yml can now run partially in pull-requests**. The default is to only run the "plan" step, which includes many integrity checks to help prevent "oops the release process is broken and we only found out when we tried to cut a release".
 
+![A GitHub PR for "chore: innocently update the Cargo.toml (to cause problems)", with the Release / plan PR check failing as a result][pr-fail]
+
 You can also crank the pull-request mode up to include the "build" step, in which case the PR Workflow Summary will include an artifacts.zip containing all the build results. We don't recommend keeping this on all the time (it's slow and wasteful), but it can be useful to temporarily turn on while testing a PR.
 
 ![A GitHub Workflow Summary from running cargo-dist's release.yml with an "artifacts" download link at the bottom][workflow-artifacts]
@@ -80,6 +84,7 @@ You can also crank the pull-request mode up to include the "build" step, in whic
 [simple-release]: ./img/simple-github-release.png
 [simple-oranda]: ./img/simple-oranda.png
 [workflow-artifacts]: ./img/workflow-artifacts.png
+[pr-fail]: ./img/pr-fail.png
 
 [github-ci]: ./ci/github.md
 [ci-providers]: ./ci/index.md