docs(release): correct the manual docs-publish fallback - #206
Merged
Conversation
Follow-ups to #204, found by an adversarial review pass over that diff. * The documented fallback was `gh workflow run docs.yml -f version=1.0` with no `--ref`. #204 added `--ref "$TAG"` to the automatic dispatch for exactly the reason it matters — without it `gh` targets the default branch — but the hand-run command next to it still omitted it. Someone recovering from a failed dispatch would publish main's current docs under a released version's label: the precise failure the fallback exists to repair. Also spells out the equivalent for the Actions UI ("Use workflow from" must be the tag). * Quote the `gh api` URL. `?` is a glob character in zsh, the default macOS shell, so the unquoted form fails with `no matches found` before `gh` runs. * State that publishing always promotes: `docs.yml` runs `mike deploy --update-aliases <label> latest` then `mike set-default --push latest`, so there is no way to refresh an old tree without taking over `latest` and the site default. Worth knowing before dispatching an older ref. Docs-only; `mkdocs build --strict` exits 0.
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-ups to #204 (which is merged). Found by an adversarial review pass over that diff — three real defects it left behind, all in
docs/release.md. Docs-only.1. The manual fallback omitted
--ref— the bug it exists to recover from#204 added
--ref "$TAG"to the automatic dispatch, precisely becausegh workflow runwithout it targets the remote's default branch. The hand-run command documented two paragraphs below it still said:So a maintainer recovering from a failed dispatch would publish whatever
mainholds at that moment under a released version's label — exactly the failure the fallback is there to repair, now with a human pressing the button. Corrected togh workflow run docs.yml --ref v1.0.0 -f version=1.0, with the Actions-UI equivalent spelled out ("Use workflow from" must be the tag, notmain).2. Unquoted
?breaks the verification command on macOSgh api repos/bioedca/tether/contents/versions.json?ref=gh-pages --jq …?is a glob character in zsh, the default shell on macOS. Unquoted, this fails withno matches foundbeforeghis ever invoked. Quoted, with a note saying why so it does not get "tidied" back.3. Publishing always promotes — now stated
docs.ymlunconditionally runsmike deploy --update-aliases <label> latestthenmike set-default --push latest. There is no way to publish a version without taking over thelatestalias and the site default. That is fine for the normal release path, but it is a trap for anyone dispatching an older ref to "just refresh" an old tree, and the runbook did not say so.Pre-existing behaviour, not introduced by #204 — documenting rather than changing it, since altering the promotion semantics right before an rc is not a docs-PR-sized decision.
Verification
mkdocs build --strictexits 0.Note on how these were found
My own multi-lens review of #204 raised all three, then my adversarial verification stage refuted them and reported the diff clean. Reading the raw findings by hand afterwards showed the verifiers were wrong, not the finders — the refute-by-default bias was set too aggressively. Codex, reviewing the same diff, independently caught two different real defects in #204 which are already fixed there. Recording this because "the automated pass said clean" was not a safe signal here.