Skip to content

test: verify PR preview build/deploy workflow - #173

Open
Maanvi212006 wants to merge 3 commits into
layer5io:masterfrom
Maanvi212006:test/preview-workflow-check
Open

test: verify PR preview build/deploy workflow#173
Maanvi212006 wants to merge 3 commits into
layer5io:masterfrom
Maanvi212006:test/preview-workflow-check

Conversation

@Maanvi212006

@Maanvi212006 Maanvi212006 commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Notes for Reviewers
Test PR to validate the split build/deploy preview workflows on this repo:

  • Confirms the build workflow triggers correctly on the watched content/** paths
  • Confirms the preview page renders and the edit is visible
  • Will be used to verify re-render on a new commit, and correct behavior on close/reopen

No actual content changes are intended — this is a throwaway test file edit
(content/certifications/your-org-uuid/certification-1/test-1.md) and this PR
will be closed without merging once verification is complete.

fixes #

Signed commits

  • Yes, I signed my commits.

Summary by CodeRabbit

  • New Features

    • Preview deployments now post a sticky comment with the preview URL and a notice that deployment may still be in progress.
    • Closed previews continue to receive a removal message.
  • Tests

    • Updated preview workflow test content with timestamped comments.
    • Confirmed document metadata and rendered content remain unaffected.
  • Chores

    • Improved preview workflow reliability and consistency.

Signed-off-by: Maanvi Chetwani <maanvichetwani21@gmail.com>
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The 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.

Changes

Preview workflow updates

Layer / File(s) Summary
Simplify preview build setup
.github/workflows/build-docs-preview.yml
Removes commented Hugo version and fallback installation settings.
Update preview deployment reporting
.github/workflows/deploy-docs-preview.yml, content/certifications/.../test-1.md
Pins workflow actions, stops waiting for Pages deployment, posts an in-progress preview notice, preserves closed-preview removal, and adds timestamped test comments.

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
Loading

Possibly related PRs

Suggested reviewers: banana-three-join

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the pull request's main purpose: testing the PR preview build and deploy workflows.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

📖 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>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 lift

Preserve PR metadata for closed pull requests.

build-docs-preview is skipped when github.event.action == closed, so .github/workflows/deploy-docs-preview.yml cannot download docs-preview-build for those runs. The deploy job then fails to get read-metadata.outputs.action and pr-number, so action: remove cannot 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

📥 Commits

Reviewing files that changed from the base of the PR and between f6282b9 and 200a344.

📒 Files selected for processing (3)
  • .github/workflows/build-docs-preview.yml
  • .github/workflows/deploy-docs-preview.yml
  • content/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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant