test: verify PR preview build/deploy workflow - #173
Conversation
Signed-off-by: Maanvi Chetwani <maanvichetwani21@gmail.com>
📝 WalkthroughWalkthroughThe preview workflows remove obsolete fallback configuration, pin action versions, and report preview URLs before Pages deployment completes. The certification test document adds two timestamped HTML comments. ChangesPreview workflow updates
Estimated code review effort: 2 (Simple) | ~10 minutes Sequence Diagram(s)sequenceDiagram
participant PreviewWorkflow
participant PagesDeployment
participant PullRequestComment
PreviewWorkflow->>PagesDeployment: Start preview deployment without waiting
PreviewWorkflow->>PullRequestComment: Post preview URL and in-progress notice
PagesDeployment-->>PullRequestComment: Deployment completes independently
PreviewWorkflow->>PullRequestComment: Remove comment when preview is closed
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
|
📖 Pull request preview: https://layer5io.github.io/academy-example/pr-preview/pr-173/ |
Signed-off-by: Maanvi Chetwani <maanvichetwani21@gmail.com>
…move dead Hugo CLI/Dart Sass code, fix preview comment format Signed-off-by: Maanvi Chetwani <maanvichetwani21@gmail.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.github/workflows/deploy-docs-preview.yml (1)
71-76: 🗄️ Data Integrity & Integration | 🟠 Major | 🏗️ Heavy liftPreserve PR metadata for closed pull requests.
build-docs-previewis skipped whengithub.event.action == closed, so.github/workflows/deploy-docs-preview.ymlcannot downloaddocs-preview-buildfor those runs. Thedeployjob then fails to getread-metadata.outputs.actionandpr-number, soaction: removecannot execute. Add a successful metadata-only job/path for closed events that does not require the build artifact, or separate the close-condition from metadata generation.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/workflows/deploy-docs-preview.yml around lines 71 - 76, Ensure deploy-docs-preview preserves PR metadata when the workflow event action is closed, even though build-docs-preview is skipped and its artifact is unavailable. Update the metadata generation path around the docs-preview-build artifact download and read-metadata outputs so closed events use a successful metadata-only path without requiring the artifact, while retaining artifact download behavior for other actions and allowing action: remove to receive the PR number.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In @.github/workflows/deploy-docs-preview.yml:
- Around line 71-76: Ensure deploy-docs-preview preserves PR metadata when the
workflow event action is closed, even though build-docs-preview is skipped and
its artifact is unavailable. Update the metadata generation path around the
docs-preview-build artifact download and read-metadata outputs so closed events
use a successful metadata-only path without requiring the artifact, while
retaining artifact download behavior for other actions and allowing action:
remove to receive the PR number.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: d7d67df6-b931-46c9-8d1a-66b2ccf990df
📒 Files selected for processing (3)
.github/workflows/build-docs-preview.yml.github/workflows/deploy-docs-preview.ymlcontent/certifications/your-org-uuid/certification-1/test-1.md
💤 Files with no reviewable changes (1)
- .github/workflows/build-docs-preview.yml
🚧 Files skipped from review as they are similar to previous changes (1)
- content/certifications/your-org-uuid/certification-1/test-1.md
Notes for Reviewers
Test PR to validate the split build/deploy preview workflows on this repo:
content/**pathsNo actual content changes are intended — this is a throwaway test file edit
(
content/certifications/your-org-uuid/certification-1/test-1.md) and this PRwill be closed without merging once verification is complete.
fixes #
Signed commits
Summary by CodeRabbit
New Features
Tests
Chores