Skip to content

ci: build release docs from the branch tip, not the dispatch ref#847

Merged
vdusek merged 1 commit into
masterfrom
ci/docs-release-build-from-branch-tip
Jun 4, 2026
Merged

ci: build release docs from the branch tip, not the dispatch ref#847
vdusek merged 1 commit into
masterfrom
ci/docs-release-build-from-branch-tip

Conversation

@vdusek
Copy link
Copy Markdown
Contributor

@vdusek vdusek commented Jun 4, 2026

Aligns the release docs deploy with apify/crawlee-python#1946, so all three Python repos build and deploy docs the same way.

In the stable release the docs build checked out the workflow-dispatch ref (the pre-bump commit), which predates the changelog finalization and the version snapshot pushed earlier in the run. This repo wasn't visibly affected — the Update docs theme step's git pull --rebase already moves the build to the latest master — but that reliance was implicit. The build now checks out the up-to-date branch tip (github.ref_name) explicitly, via a new optional ref input on manual_release_docs.yaml. Other entry points (on-master docs deploys, manual dispatches) are unaffected because ref defaults to the triggering ref.

Unlike here, crawlee-python lacks the theme-update step, so there the stale ref actually broke the deployed changelog (stuck at "not yet released") — see apify/crawlee-python#1946 for the full diagnosis.

Aligns the release docs deploy with apify/crawlee-python: the docs build now checks out the up-to-date branch tip (via a new optional `ref` input) instead of the workflow-dispatch commit, which predates the changelog finalization and version snapshot pushed earlier in the run. The build already reached the latest master here through the theme-update step's pull, so this is effectively a no-op — it just makes the behavior explicit and keeps the three repos' release pipelines identical.
@vdusek 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 Jun 4, 2026
@vdusek vdusek self-assigned this Jun 4, 2026
@vdusek vdusek requested a review from janbuchar June 4, 2026 11:39
@github-actions github-actions Bot added this to the 142nd sprint - Tooling team milestone Jun 4, 2026
@vdusek vdusek marked this pull request as ready for review June 4, 2026 11:46
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.82%. Comparing base (6c68c8b) to head (168c668).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #847   +/-   ##
=======================================
  Coverage   94.82%   94.82%           
=======================================
  Files          48       48           
  Lines        5045     5045           
=======================================
  Hits         4784     4784           
  Misses        261      261           
Flag Coverage Δ
integration 93.22% <ø> (+0.01%) ⬆️
unit 83.52% <ø> (ø)

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

☔ View full report in Codecov by Harness.
📢 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 vdusek merged commit 04c993c into master Jun 4, 2026
27 checks passed
@vdusek vdusek deleted the ci/docs-release-build-from-branch-tip branch June 4, 2026 12:07
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