fix: surface generate_ast.py failures with a clear error#76
Merged
Conversation
spawnSync only sets .error when the spawn itself fails — a non-zero exit of the script went unnoticed and the plugin died later with a confusing "ENOENT: pydoc-markdown-dump.json". Check the exit code and include the script's stderr in the thrown error so the real cause (e.g. a missing pydoc-markdown install) is visible in CI logs.
vdusek
requested review from
barjin and
janbuchar
and removed request for
janbuchar
barjin
approved these changes
Jun 3, 2026
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
3 participants
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
processPythonDocsonly checksspawnSync().error, which is set when the spawn itself fails — a non-zero exit ofgenerate_ast.py(e.g.pydoc-markdownnot importable by the resolvedpython) went completely unnoticed. The plugin then crashed later with a confusingENOENT: pydoc-markdown-dump.json, hiding the real cause.This is exactly what made the broken
Version docsCI job in apify/apify-sdk-python (failed 3.4.0/3.4.1 doc releases) hard to diagnose — see apify/apify-sdk-python#928 for the workflow-side fix.Now the exit code is checked and the script's stderr is included in the thrown error:
Verified by building the plugin, dropping the compiled output into the SDK website's
node_modules, and runningdocusaurus api:versionwith a stubpythonthat exits 1.