CI: Fix intermittent docs build failures #1307
Merged
Conversation
This file contains 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
adamziel
added
[Type] Enhancement
adamziel
added a commit
that referenced
this pull request
Apr 23, 2024
Related to #1287 TypeScript 5.4.5 (well, technically 5.2) gives us the [Disposable](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html) interface for cleaning up resources. Also includes the changes from [CI: Fix intermittent docs build failures](#1307): Building the documentation page often fails. This PR is an exploration to fix it. It: * Patches the typedoc library in `node_modules` as otherwise it won't work with TypeScript 5.4 🙈 * Removes non-essential TypeDoc plugins (link API reference to MDN, cross-link Typedoc modules) * Copies the `rollup.d.ts` files to `dist` instead of moving them. TypeDoc, apparently, expects to find them in their original location: ``` error TS6053: File '/home/runner/work/wordpress-playground/wordpress-playground/packages/php-wasm/web/src/rollup.d.ts' not found. The file is in the program because: Root file specified for compilation ```
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.
What is this PR doing?
Building the documentation page often fails. This PR is an exploration to fix it. It:
node_modulesas otherwise it won't work with TypeScript 5.4 🙈rollup.d.tsfiles todistinstead of moving them. TypeDoc, apparently, expects to find them in their original location:Testing Instructions
Restart the CI 5 times, confirm the build worked every single time.