ci(docs): Upgrade Docusaurus to 3.10.0, pin webpack dep and track docs/yarn.lock for deterministic CI runs#2817
Merged
awahab07 merged 4 commits intoApr 10, 2026
Conversation
Collaborator
Author
|
buildkite test this |
3.10.0, pin webpack dep and track docs/yarn.lock for deterministic CI runs
nickofthyme
approved these changes
Apr 10, 2026
Collaborator
nickofthyme
left a comment
There was a problem hiding this comment.
Good catch, I didn't realize at the time non-workspace lock files were needed.
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.
Summary
@docusaurus/*@^3.10.0docs/yarn.lockso docs installs are deterministic in CIwebpackversion to5.105.1, which is compatible with the currently resolvedwebpackbar@6.0.1Problem
The docs step started failing on PR builds such as build 223 and build 228, including on PR #2816, with the following error:
[ERROR] Error: Unable to build website for locale en. -- ... [cause]: ValidationError: Invalid options object. Progress Plugin has been initialized using an options object that does not match the API schema.The underlying issue was not simply "Docusaurus 3.10 is broken". The docs workspace did not have a tracked lockfile, so
yarn install --frozen-lockfilehad nothing to freeze indocs/and CI was free to resolve newer transitive versions than local development.Solution / Fix
This PR makes the docs install path deterministic and upgrades it intentionally:
@docusaurus/*@^3.2.1to@docusaurus/*@^3.10.0docs/yarn.lockwebpackto5.105.1viaresolutionsindocs/package.jsonDetails / Background
yarn install --frozen-lockfileis only protective when a lockfile is actually present and tracked. Withoutdocs/yarn.lock, CI was still resolving fresh versions for the docs workspace.yarn.lockfiles globally, whilee2e/explicitly re-included its own lockfile..buildkite/yarn.lockis tracked because it predates that ignore rule. Tracked files stay tracked even if a later ignore rule would have matched them.docs/yarn.locknever entered git.webpackrelease timing more than with a docs source change on the branch:webpack@5.106.0was publishedwebpackbar@6.0.1works throughwebpack@5.105.1and starts failing withwebpack@5.106.0+, while Docusaurus3.10.0itself still builds successfully whenwebpackis kept on5.105.1.How to test
yarn typedocDOCUSAURUS_URL="https://example.com" DOCS_URL="https://example.com" yarn --cwd docs buildyarn typecheck:allyarn testThe generated docs on this PR can also be compared with one of earlier build versions e.g.