Repository navigation
fix(ci): pin and reuse the docs validation CLI - #6080
Conversation
55b60d2 to
24abd46
Compare
jrusso1020
left a comment
There was a problem hiding this comment.
Reviewed at 7e21df9. No blockers found. The only change since the first pinned head (24abd46) raises the docs job timeout from 5 to 10 minutes. The install and validation commands are byte-identical.
.github/workflows/docs.yml:57-70 installs mint@4.2.1096 once into the runner's temp directory and puts its bin directory on GITHUB_PATH for both validators, keeping the docs working directory. A workflow-only change still triggers both the PR and push paths. Job and check names are unchanged, and so is the contents: read permission. The earlier hosted run was pinned to 24abd46 and was cancelled, so I don't count it as a green run at this head.
What ran at 24abd46:
- A clean Linux install succeeded.
mint validateandmint broken-links --check-redirectsboth passed.- The schema mirror checks and the 49-command documentation check passed.
- The parsed workflow and trigger assertions and
bash -non the install snippet passed. actionlint wasn't available.
This pins the CLI release, not its full transitive dependency graph. Hosted runs with the longer timeout and fork behaviour weren't independently verified.
Review by Rames (hf-review)
What
Install
mint@4.2.1096once per docs job and reuse it for build validation and broken-link checks.Why
Unversioned
npx mintpicked up a release whose dependency tarball returned 404, so the docs check failed before reading the documentation. A pinned install keeps validator upgrades out of unrelated PRs and gives both checks the same executable.Related work
Unblocks the docs check on #6068 and other PRs that change documentation.
How
Install into the runner's temporary directory and add its binary directory to
PATH. Include this workflow in its own path filters so workflow-only changes run the checks. Give the job ten minutes to complete both checks.Test plan
mint validate: build validation passed.mint broken-links --check-redirects: no broken links found.Runtime evidence
The first rebased run reached the existing five-minute timeout:
Build validation passed. Broken-link checking printed “success no broken links found” as the job was canceled at 5 minutes 6 seconds. The checks themselves took 4 minutes 8 seconds, while installation accounted for about 10% of total runtime. A ten-minute limit leaves room for the actual checks and runner variation; caching installation alone would leave little headroom under five minutes.