Skip to content

ci: Extract docs versioning and release into reusable workflows#1846

Merged
vdusek merged 15 commits intomasterfrom
ci/extract-docs-versioning-workflow
Apr 16, 2026
Merged

ci: Extract docs versioning and release into reusable workflows#1846
vdusek merged 15 commits intomasterfrom
ci/extract-docs-versioning-workflow

Conversation

@vdusek
Copy link
Copy Markdown
Collaborator

@vdusek vdusek commented Apr 15, 2026

Summary

Docs versioning (manual_version_docs.yaml):

  • Extract the inline version_docs job from manual_release_stable.yaml into a standalone reusable workflow
  • Can be triggered manually from the GitHub UI (with an optional ref input) or called from the release pipeline
  • Fix api:version ENOENT bug by running docusaurus commands through uv run
  • Clean up all existing versions for the same major version, not just exact major.minor match
  • Remove non-docs artifacts (pyproject.toml, .gitignore, caches) from versioned doc snapshots

Docs release (manual_release_docs.yaml):

  • Rename _release_docs.yaml to manual_release_docs.yaml to match the naming convention
  • Add 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 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

🤖 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>
@vdusek vdusek added t-tooling Issues with this label are in the ownership of the tooling team. adhoc Ad-hoc unplanned task added during the sprint. labels Apr 15, 2026
@vdusek vdusek self-assigned this Apr 15, 2026
@github-actions github-actions bot added this to the 138th sprint - Tooling team milestone Apr 15, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.34%. Comparing base (f241ead) to head (18da928).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1846   +/-   ##
=======================================
  Coverage   92.34%   92.34%           
=======================================
  Files         157      157           
  Lines       10921    10921           
=======================================
  Hits        10085    10085           
  Misses        836      836           
Flag Coverage Δ
unit 92.34% <ø> (ø)

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.

vdusek and others added 14 commits April 15, 2026 09:57
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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 changelog.md, pyproject.toml, and .gitignore
inside website/versioned_docs/ so git add never stages them. This replaces
the explicit rm commands in the workflow since .ruff_cache and .ty_cache
are already covered by global 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>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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

Match the structure of `manual_version_docs.yaml` so it can be triggered
both from the GitHub UI (with an optional ref input) and from other workflows.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vdusek vdusek changed the title ci: Extract docs versioning into reusable manual_version_docs.yaml workflow ci: Extract docs versioning and release into reusable workflows Apr 15, 2026
@vdusek vdusek requested a review from Pijukatel April 15, 2026 12:36
@vdusek vdusek marked this pull request as ready for review April 15, 2026 12:36
Copy link
Copy Markdown
Collaborator

@Pijukatel Pijukatel left a comment

Choose a reason for hiding this comment

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

I would prefer to have this defined once in the workflow repo.

Similar:
#1846
apify/apify-client-python#728
apify/apify-sdk-python#857
apify/apify-client-js#876

@vdusek
Copy link
Copy Markdown
Collaborator Author

vdusek commented Apr 16, 2026

I would prefer to have this defined once in the workflow repo.

Let's go step by step, merge it, migrate to pnpm, see whether everything works, and then try to extract the general part to the workflows.

@vdusek vdusek merged commit 306dc46 into master Apr 16, 2026
59 of 61 checks passed
@vdusek vdusek deleted the ci/extract-docs-versioning-workflow branch April 16, 2026 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants