Conversation
Add Docusaurus versioning with version dropdown, version snapshots for 3.3, 2.7, and 1.7, and automated versioning in the release workflow. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
vdusek
added
adhoc
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #834 +/- ##
=======================================
Coverage 86.47% 86.47%
=======================================
Files 48 48
Lines 2905 2905
=======================================
Hits 2512 2512
Misses 393 393
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| # Use the default branch ref to include both changelog and versioned docs. | ||
| ref: ${{ github.ref }} |
There was a problem hiding this comment.
As far as GitHub docs are concerned (link), github.ref ...is the branch or tag ref that triggered the workflow run.
If I understand correctly, this will be the commit that this workflow_dispatch was invoked on, without the changelog and versioned docs.
There was a problem hiding this comment.
Good catch, thanks, fixed - now it uses needs.version_docs.outputs.version_docs_commitish which should include both changelog and versioned docs.
| with: | ||
| token: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }} |
There was a problem hiding this comment.
Perhaps we can explicitly checkout the needs.changelog_update.outputs.changelog_commitish, to prevent race conditions or other mishaps?
There was a problem hiding this comment.
Done, checkout now explicitly uses ref: ${{ needs.changelog_update.outputs.changelog_commitish }}
There was a problem hiding this comment.
How are these changes connected to the rest of the PR? IIRC this is done automatically by docusaurus-plugin-typedoc-api 🤔
There was a problem hiding this comment.
Interesting, this should follow the same pattern as in apify-client-python, if I undo these changes and remove the transform docs script and pydoc markdown yaml it does not work.
There was a problem hiding this comment.
Okay, I tried a bit more, they are gone and I'll remove them from the Client's docs as well, thanks!
website/transformDocs.js
Outdated
There was a problem hiding this comment.
Same for this file, it shouldn't be necessary to do this here.
There was a problem hiding this comment.
Interesting, this should follow the same pattern as in apify-client-python, if I undo these changes and remove the transform docs script and pydoc markdown yaml it does not work.
There was a problem hiding this comment.
Okay, I tried a bit more, they are gone and I'll remove them from the Client's docs as well, thanks!
3 participants
Summary
Mirrors the approach from apify-client-python PRs #674 and #676.
Test plan