ci: build release docs from the branch tip, not the dispatch ref#847
Merged
Conversation
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.
Codecov Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
janbuchar
approved these changes
Jun 4, 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
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.
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 themestep'sgit pull --rebasealready 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 optionalrefinput onmanual_release_docs.yaml. Other entry points (on-master docs deploys, manual dispatches) are unaffected becauserefdefaults 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.