Skip to content

🛠️ Script for reliable API build cleanup#2449

Open
JFWooten4 wants to merge 1 commit into
stellar:mainfrom
JFWooten4:fix-cross-platform-api-info-routes
Open

🛠️ Script for reliable API build cleanup#2449
JFWooten4 wants to merge 1 commit into
stellar:mainfrom
JFWooten4:fix-cross-platform-api-info-routes

Conversation

@JFWooten4
Copy link
Copy Markdown
Contributor

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 rm to delete all *.info.mdx files. 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/promises that works on all platforms. It also paves the way for more intricate post-generation formatting as formulated in the APN notes from #2418.

Co-authored-by: Codex <noreply@openai.com>
Copilot AI review requested due to automatic review settings May 13, 2026 03:29
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.mjs to remove generated *.info.mdx files via fs/promises in a platform-independent way.
  • Updated package.json api:gen script to run the new Node cleanup step after docusaurus 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants