Skip to content

[CI]: Standardize docs preview build - #245

Open
yats0x7 wants to merge 1 commit into
layer5io:masterfrom
yats0x7:codex/standardize-preview-build
Open

[CI]: Standardize docs preview build#245
yats0x7 wants to merge 1 commit into
layer5io:masterfrom
yats0x7:codex/standardize-preview-build

Conversation

@yats0x7

@yats0x7 yats0x7 commented Aug 10, 2026

Copy link
Copy Markdown

Summary

This updates the pull request preview workflow to use the repository's shared preview build target and keeps preview cleanup reliable when a pull request closes.

Changes

  • Build previews through make build-preview, keeping CI aligned with the Makefile entry point used by the repository.
  • Preserve the unprivileged build and artifact handoff to the deployment workflow.
  • Upload a metadata-only artifact for closed pull requests so the existing deployment workflow can remove the associated preview.
  • Remove inactive toolchain-install notes that no longer describe the active workflow.

Validation

  • git diff --check
  • YAML parsing for the preview build and deployment workflows
  • make -n build-preview
  • Focused security review of the build-to-deploy handoff

Closes #231

Summary by CodeRabbit

  • Chores
    • Improved documentation preview build workflows.
    • Preview artifacts now include only the intended generated content.
    • Closed pull request handling now preserves and uploads relevant metadata separately.

Signed-off-by: yats0x7 <kattayatharth@gmail.com>
@yats0x7
yats0x7 force-pushed the codex/standardize-preview-build branch from f8b7093 to fa80700 Compare August 10, 2026 14:52
@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 7af5dd7f-36dc-4ae3-a85c-f5ae4e2a177e

📥 Commits

Reviewing files that changed from the base of the PR and between 9485b16 and fa80700.

📒 Files selected for processing (1)
  • .github/workflows/build-docs-preview.yml

📝 Walkthrough

Walkthrough

The documentation preview workflow removes obsolete tool setup, uses make build-preview, restricts uploaded artifacts to public and pr/, and adds a separate job for closed pull request metadata.

Changes

Documentation preview workflow

Layer / File(s) Summary
Standardize the preview build
.github/workflows/build-docs-preview.yml
The workflow removes unused Hugo and Dart Sass setup and changes the preview command to make build-preview.
Separate preview and closed-PR artifacts
.github/workflows/build-docs-preview.yml
The workflow uploads only public and pr/ for previews. A separate closed pull request job writes and uploads pull request metadata.---

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related issues

Possibly related PRs

Suggested reviewers: banana-three-join, rishiraj38

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The workflow uses make and artifacts, but the context does not show rollout across all meshery-academy repositories or removal of PR-ref checkout under pull_request_target for #231. Apply the standardized workflow to every meshery-academy repository and confirm pull_request_target does not check out pull request refs.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the CI change to standardize the documentation preview build.
Out of Scope Changes check ✅ Passed The changes support preview standardization, artifact transfer, cleanup metadata, and removal of obsolete installation notes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ 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.

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.

[CI]: Standardize the PR preview-deploy workflow across meshery-academy repos

1 participant