fix: use build artifacts for production deployment instead of rebuilding - #236
Conversation
The deploy-production job in push.yml was rebuilding all Sphinx docs from scratch instead of using the validated output from the build-docs job. This caused deployed content to potentially differ from what was validated, and wasted ~40% of workflow time. Changes: - Add upload-artifact step in build-docs-optimized.yml for push deployments - Replace redundant conda/Sphinx rebuild in push.yml with artifact download - Add build failure tracking with GitHub Actions warning annotations - Add deploy verification marker to forsida/index.rst Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. WalkthroughThe PR refactors the documentation build and deployment workflow to improve artifact management. It introduces failure tracking in the optimized build process, adds artifact upload steps for production deployments, simplifies the push workflow to use pre-built artifacts instead of rebuilding, and includes a deployment verification marker. Changes
Sequence Diagram(s)sequenceDiagram
participant BuildJob as Build Job<br/>(build-docs-optimized)
participant ArtifactStore as Artifact Storage
participant PushJob as Push Job<br/>(push.yml)
participant Deployment as Deployment
BuildJob->>BuildJob: Build Sphinx docs<br/>with failure tracking
BuildJob->>BuildJob: Collect failures<br/>to build_failures.txt
BuildJob->>ArtifactStore: Upload _build artifacts
BuildJob->>BuildJob: Generate failure<br/>summary report
PushJob->>ArtifactStore: Download pre-built<br/>artifacts
PushJob->>PushJob: Use artifacts<br/>instead of rebuilding
PushJob->>Deployment: Prepare deployment<br/>structure
PushJob->>Deployment: Deploy content
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
✨ Finishing touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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. Comment |
📚 PR Documentation DeployedYour PR documentation is available with enhanced build performance: 🔗 PR Documentation: https://edbook.github.io/haskoli-islands/002-fix-deploy-artifacts/ ✨ Performance Features:
Version: |
Summary
deploy-productionjob inpush.ymlwas rebuilding all Sphinx documentation from scratch instead of using the validated output from thebuild-docsjobupload-artifact@v4/download-artifact@v4, eliminating the redundant build entirelyChanges
build-docs-optimized.ymlupload-artifact@v4step for push deployments (uploads_build/asproduction-buildartifact)::warning::annotationspush.ymlprojects/forsida/index.rstTest plan
production-buildappears in workflow artifactsdeployment_type == 'push')🤖 Generated with Claude Code
Summary by CodeRabbit