Makes the OpenAPI docs generation more robust #14175
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
I learned something new with `pre-commit`: when you use the default `pass_filenames: true`, all of the affected files are split into chunks and sent to many instances of your hook in parallel. Running `mintlify-scrape` in parallel is pretty flakey and has been giving people fits. Since this hook doesn't need the specific filenames, we can turn off that option so it will just invoke the script once. Additionally, I'm using a more robust way to install `mintlify-scrape` with the `npx` command, which will install it to the right place in a way that doesn't require installing it globally.
bunchesofdonald
approved these changes
Jun 20, 2024
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 learned something new with
pre-commit: when you use the defaultpass_filenames: true, all of the affected files are split into chunks and sentto many instances of your hook in parallel. Running
mintlify-scrapeinparallel is pretty flakey and has been giving people fits. Since this hook
doesn't need the specific filenames, we can turn off that option so it will
just invoke the script once.
Additionally, I'm using a more robust way to install
mintlify-scrapewiththe
npxcommand, which will install it to the right place in a way thatdoesn't require installing it globally.