Create deploy.yml - #274
Conversation
|
@AvatarMiiDe Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
|
This workflow runs |
|
Good starting point for #254. Two things to align on: (1) the issue asks for a 'shareable preview build' for PRs — right now this uploads a plain workflow artifact, which requires manual download rather than a link reviewers can click. Could you look at something like a preview subdomain/path or a bot comment with a direct link? (2) #284 also adds a |
What Was Designed
The workflow (.github/workflows/deploy.yml) is set up to provide the following:
Build on PRs: Automatically triggers mdbook test and mdbook build to catch broken links and code test failures in your mdBook docs before they can be merged.
PR Preview Artifacts: On PRs, the built book/ directory is zipped and uploaded using actions/upload-artifact@v4 as site-preview. Reviewers can download the built HTML artifacts directly from the PR's "Checks" tab to preview the visual appearance of the documentation locally before approving the merge.
GitHub Pages Deployment: On merges to main, the deploy job leverages GitHub's native actions/deploy-pages@v4 workflow. This integrates smoothly with GitHub's newer Actions-based Pages deployment system.
NOTE: Go to your repository settings in GitHub: Settings > Pages > Build and deployment. Make sure the Source is set to GitHub Actions, rather than "Deploy from a branch".
Close #254