Skip to content

Commit 695500e

Browse files
authored
ci: run docs versioning commands through uv run (#928)
## Summary The `Version docs` job has failed on both the 3.4.0 and 3.4.1 releases, which also skipped the dependent `Doc release` job — the docs site is still stuck on 3.3 (version dropdown and `Version: 3.3` badge). Root cause: the pnpm migration (#855) changed the snapshot step from `uv run npx docusaurus ...` to plain `pnpm exec docusaurus ...`, dropping the `uv run` wrapper. The `@apify/docusaurus-plugin-typedoc-api` plugin spawns a bare `python` to generate the API reference dump (`generate_ast.py`), which needs `pydoc-markdown` from the project venv. Without `uv run`, the venv is not on PATH, the script fails (the plugin only checks for spawn errors, not the exit code), and the job dies later with `ENOENT: pydoc-markdown-dump.json` — exactly what the logs of runs [26631120750](https://github.com/apify/apify-sdk-python/actions/runs/26631120750) and [25363849495](https://github.com/apify/apify-sdk-python/actions/runs/25363849495) show. This restores the `uv run` wrapper (consistent with the `build-docs` poe task, which is why doc deploys themselves still worked) and adds a comment explaining why it is needed. Verified locally: the snapshot sequence fails without `uv run` and passes with it. Follow-up (separate from this PR): the fix needs to be cherry-picked to `release-v3`, `Version docs` re-dispatched there with version `3.4.1`, `Release docs` re-dispatched, and the snapshot synced back to master.
1 parent da81ac8 commit 695500e

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

.github/workflows/manual_version_docs.yaml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,12 @@ jobs:
120120
echo "No existing versions found for major $MAJOR_VERSION, nothing to remove"
121121
fi
122122
123-
# Build API reference and create Docusaurus version snapshots.
123+
# Build API reference and create Docusaurus version snapshots. The Docusaurus commands must run
124+
# through `uv run` so that the project virtual environment is on PATH — the typedoc-api plugin
125+
# spawns `python` to generate the API reference dump and needs `pydoc-markdown` to be importable.
124126
bash build_api_reference.sh
125-
pnpm exec docusaurus docs:version "$MAJOR_MINOR_VERSION"
126-
pnpm exec docusaurus api:version "$MAJOR_MINOR_VERSION"
127+
uv run pnpm exec docusaurus docs:version "$MAJOR_MINOR_VERSION"
128+
uv run pnpm exec docusaurus api:version "$MAJOR_MINOR_VERSION"
127129
128130
- name: Commit and push versioned docs
129131
uses: apify/actions/signed-commit@v1.2.0

0 commit comments

Comments
 (0)