another attempt to fix version doc-build #496
Conversation
WalkthroughThis pull request reorganizes the GitHub Actions workflow for deploying stable documentation. It updates the release trigger syntax, removes the environment declaration and deployment steps from the build job (including commenting out the pages setup step), and introduces a new deploy job. The deploy job runs on Changes
Sequence Diagram(s)sequenceDiagram
participant RT as Release Trigger
participant B as Build Job
participant D as Deploy Job
participant GP as GitHub Pages
RT->>B: Trigger build (release event)
B->>B: Run build steps (skip pages setup)
B->>D: On success, signal deploy
D->>GP: Deploy using actions/deploy-pages@v4
Possibly related PRs
Suggested labels
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
d-chambers
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/workflows/build_deploy_stable_docs.yaml (2)
7-7: Review Trigger Formatting Spacing:
The release trigger now usestypes: [ created ]with additional spacing. Please confirm that this formatting change is intentional and does not affect the trigger behavior in GitHub Actions.
40-42: Commented 'Setup Pages' Step:
TheSetup Pagesstep in the build job has been commented out. If this is a temporary measure while reorganizing the deployment logic, consider adding a clarifying comment regarding its future status or remove it entirely once it’s no longer needed.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/build_deploy_stable_docs.yaml(2 hunks)
🔇 Additional comments (2)
.github/workflows/build_deploy_stable_docs.yaml (2)
48-51: Conditional Artifact Zipping:
Adding the conditionif: startsWith(github.ref, 'refs/tags/')to the "Zip doc build" step ensures that artifacts are only created for tagged releases. This is a sound decision aligned with release workflows.
58-69: New Deploy Job Implementation:
The introduction of the separatedeployjob cleanly separates build and deployment steps. Usingneeds: buildguarantees that deployment only occurs after a successful build. Additionally, updating the deployment action toactions/deploy-pages@v4helps ensure you are using a more recent version. Verify that the dynamic URL reference (${{ steps.deployment.outputs.page_url }}) is correctly populated by the deployment step.
Description
This builds on #494 and #495 in attempting to fix the doc-build action.
Checklist
I have (if applicable):
Summary by CodeRabbit
New Features
Refactor