ci: Extract docs versioning into reusable `manual_version_docs.yaml` workflow by vdusek · Pull Request #857 · apify/apify-sdk-python

vdusek · 2026-04-15T07:52:00Z

Summary

Extract the inline version_docs job from manual_release_stable.yaml into a standalone manual_version_docs.yaml workflow
The new workflow can be triggered manually (for docs fixes) or called from the release pipeline
Fix api:version ENOENT bug by running docusaurus commands through uv run (Python deps not available to bare npx)
Clean up ALL versions for the same major version, not just exact major.minor match
Remove non-docs artifacts (pyproject.toml, .gitignore, caches) from versioned doc snapshots

🤖 Generated with Claude Code

…workflow Extract the inline `version_docs` job from `manual_release_stable.yaml` into a standalone workflow that can be triggered manually or called from the release pipeline. Key improvements: - Fix `api:version` ENOENT bug by running docusaurus commands through `uv run` - Clean up ALL versions for the same major (not just exact major.minor match) - Remove non-docs artifacts (pyproject.toml, .gitignore, caches) from snapshots Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

codecov · 2026-04-15T07:53:43Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.64%. Comparing base (9474a6b) to head (cee2764).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #857      +/-   ##
==========================================
+ Coverage   86.57%   86.64%   +0.06%     
==========================================
  Files          48       48              
  Lines        2920     2920              
==========================================
+ Hits         2528     2530       +2     
+ Misses        392      390       -2

Flag	Coverage Δ
e2e	`37.87% <ø> (ø)`
integration	`59.28% <ø> (ø)`
unit	`74.69% <ø> (+0.06%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Query versions.json for the specific existing version for a given major instead of aggressively globbing version-${MAJOR}.*. This means: - Major release (e.g. 3.0.0): nothing is deleted (new major, no prior minor) - Minor release (e.g. 3.1.0): only the exact old minor (3.0) is removed - Patch release (e.g. 3.1.1): only the exact current minor (3.1) is removed and recreated Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

…cs artifacts Add gitignore patterns for pyproject.toml and .gitignore inside website/versioned_docs/ so git add never stages them. This replaces the explicit rm commands in the workflow since changelog.md, .ruff_cache, and .ty_cache are already covered by existing patterns. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Pijukatel

Test in production

Copilot

Pull request overview

This PR refactors the docs versioning step out of the stable release workflow into a reusable GitHub Actions workflow that can be run manually or invoked from the release pipeline, while also adjusting how docs versions are created/cleaned and how Docusaurus is executed.

Changes:

Added a new reusable workflow (manual_version_docs.yaml) to snapshot/version Docusaurus docs and commit the results.
Updated manual_release_stable.yaml to call the reusable workflow instead of embedding the versioning logic inline.
Updated .gitignore to ignore pyproject.toml files inside website/versioned_docs/*.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.

File	Description
`.gitignore`	Ignores `website/versioned_docs/*/pyproject.toml` artifacts from being committed.
`.github/workflows/manual_version_docs.yaml`	New reusable workflow for versioning docs and committing versioned snapshots.
`.github/workflows/manual_release_stable.yaml`	Replaces inline docs versioning job with a call to the new reusable workflow.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Pass inputs.ref, github.event.repository.default_branch, and steps outputs through env variables instead of direct ${{ }} interpolation in run: blocks. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

…kflow (#858) Follow-up to #857 ## Summary - Rename `_release_docs.yaml` to `manual_release_docs.yaml` to match the naming convention of other reusable workflows (`manual_version_docs.yaml`, `manual_release_stable.yaml`). - Add an optional `ref` input to `workflow_dispatch` so it can be triggered from the GitHub UI with a specific ref (falling back to the default branch). - Replace the `CHECKOUT_REF` env var approach with a `Determine checkout ref` step, consistent with `manual_version_docs.yaml`. - Update all references in `manual_release_stable.yaml` and `on_master.yaml`. Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Apr 15, 2026

vdusek self-assigned this Apr 15, 2026

github-actions bot added this to the 138th sprint - Tooling team milestone Apr 15, 2026

vdusek and others added 5 commits April 15, 2026 09:57

fix: Quote variable expansions in for loop globs to satisfy shellcheck

35424c7

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

refactor: Merge website deps install into snapshot step

d832d68

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

refactor: Use [[ instead of [ for bash conditionals

4cb04e0

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

refactor: Include version number in docs versioning commit message

6232541

vdusek marked this pull request as ready for review April 15, 2026 08:35

vdusek and others added 5 commits April 15, 2026 10:39

refactor: Remove unnecessary quotes and move env to workflow level

2cbc62d

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

refactor: Use uv version --short to extract project version

d94ab95

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

refactor: Use more precise variable names for version identifiers

4859af2

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

refactor: Remove unnecessary .gitignore pattern from versioned docs

beee4da

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Pijukatel requested a review from Copilot April 15, 2026 08:54

Copilot started reviewing on behalf of Pijukatel April 15, 2026 08:55 View session

Pijukatel approved these changes Apr 15, 2026

View reviewed changes

Copilot AI reviewed Apr 15, 2026

View reviewed changes

Comment thread .github/workflows/manual_version_docs.yaml Outdated

Comment thread .github/workflows/manual_version_docs.yaml Outdated

vdusek and others added 3 commits April 15, 2026 12:39

refactor: Quote NODE_VERSION env value for consistency

9037b07

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix: Remove all old versions for same major, not just the first match

d944121

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix: Prevent script injection in workflow run blocks

cee2764

Pass inputs.ref, github.event.repository.default_branch, and steps outputs through env variables instead of direct ${{ }} interpolation in run: blocks. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

vdusek merged commit 0d26276 into master Apr 15, 2026
29 checks passed

vdusek deleted the ci/extract-docs-versioning-workflow branch April 15, 2026 10:53

vdusek mentioned this pull request Apr 15, 2026

ci: Extract docs release into reusable manual_release_docs.yaml workflow #858

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: Extract docs versioning into reusable `manual_version_docs.yaml` workflow#857

ci: Extract docs versioning into reusable `manual_version_docs.yaml` workflow#857
vdusek merged 14 commits intomasterfrom
ci/extract-docs-versioning-workflow

vdusek commented Apr 15, 2026

Uh oh!

codecov bot commented Apr 15, 2026 •

edited

Loading

Uh oh!

Pijukatel left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

vdusek commented Apr 15, 2026

Summary

Uh oh!

codecov bot commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Pijukatel left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Apr 15, 2026 •

edited

Loading