🛠️ Script for reliable API build cleanup#2449
Open
JFWooten4 wants to merge 1 commit into
Open
Conversation
Co-authored-by: Codex <noreply@openai.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR replaces shell-specific rm glob/brace cleanup in the API docs generation pipeline with a cross-platform Node-based cleanup script, addressing Windows shell incompatibilities encountered during yarn api:gen.
Changes:
- Added
scripts/api-build-cleanup.mjsto remove generated*.info.mdxfiles viafs/promisesin a platform-independent way. - Updated
package.jsonapi:genscript to run the new Node cleanup step afterdocusaurus gen-api-docs all.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| scripts/api-build-cleanup.mjs | Adds a Node-based cleanup routine that deletes *.info.mdx files in known API output directories, tolerating missing directories. |
| package.json | Replaces shell rm glob/brace expansions with node scripts/api-build-cleanup.mjs for reliable cross-platform execution. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
I ran into a problem when changing files unrelated to the API sections, which showed up in #2448 (comment). The current script build command generates the API docs and then uses
rmto delete all*.info.mdxfiles. However, this runs through the actual command shorthand in the shell glob/brace expansion, which behaves differently depending on the shell/OS.These errors showed up on my Windows setup, even though they don't appear on OSX. This PR changes the script to use a Node cleanup environment with
fs/promisesthat works on all platforms. It also paves the way for more intricate post-generation formatting as formulated in the APN notes from #2418.