Skip to content

fix: Release deploy of docs - #6095

Merged
wayfarer3130 merged 1 commit into
masterfrom
fix/netlify-deploy-directory
Jun 19, 2026
Merged

fix: Release deploy of docs#6095
wayfarer3130 merged 1 commit into
masterfrom
fix/netlify-deploy-directory

Conversation

@wayfarer3130

@wayfarer3130 wayfarer3130 commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

No functional change, just deploy the docs in the newer pnpm world

Context

Changes & Results

Testing

Checklist

PR

  • [] My Pull Request title is descriptive, accurate and follows the
    semantic-release format and guidelines.

Code

  • [] My code has been well-documented (function documentation, inline comments,
    etc.)

Public Documentation Updates

  • [] The documentation page has been updated as necessary for any public API
    additions or removals.

Tested Environment

  • [] OS:
  • [] Node version:
  • [] Browser:

Summary by CodeRabbit

  • Chores
    • Optimized documentation deployment configuration to improve build consistency and prevent redundant build steps.

Greptile Summary

This PR fixes the docs deployment step in the GitHub Actions workflow to work correctly in the pnpm monorepo. The old approach cd-ed into platform/docs before invoking netlify-cli, but without --no-build the CLI would still attempt to run its own build using the repo-root netlify.toml (which targets the main viewer app, not the docs).

  • The deploy step now uses --no-build so netlify-cli deploys the already-built output without triggering a second build, and --dir is updated to the repo-root-relative path platform/docs/build to match the new working directory assumption.

Confidence Score: 5/5

Safe to merge — the change is a targeted, well-explained one-liner fix with no functional side-effects on the rest of the workflow.

The only touched file is the docs deploy step of a GitHub Actions workflow. The fix is minimal and correct: it prevents netlify-cli from running a redundant (and wrong) build by adding --no-build, and adjusts the --dir path to be repo-root-relative to match the new invocation context. Secrets remain properly sourced from environment variables, and the rest of the workflow is untouched.

No files require special attention.

Important Files Changed

Filename Overview
.github/workflows/build-docs.yml Replaces a two-step cd + npx netlify-cli deploy invocation with a single-line deploy using --no-build and a repo-root-relative --dir, preventing netlify-cli from re-running the wrong build via the root netlify.toml.

Reviews (1): Last reviewed commit: "fix: Release deploy of docs" | Re-trigger Greptile

@wayfarer3130
wayfarer3130 requested a review from jbocce June 19, 2026 16:07
@netlify

netlify Bot commented Jun 19, 2026

Copy link
Copy Markdown

Deploy Preview for ohif-dev ready!

Name Link
🔨 Latest commit 8ca2647
🔍 Latest deploy log https://app.netlify.com/projects/ohif-dev/deploys/6a356954aee88f00088fe69e
😎 Deploy Preview https://deploy-preview-6095--ohif-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jun 19, 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: 05a6c5ee-5b80-4290-a83d-26966ab069e0

📥 Commits

Reviewing files that changed from the base of the PR and between 57d03fc and 8ca2647.

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

📝 Walkthrough

Walkthrough

The Netlify deployment step in the docs build GitHub Actions workflow is updated to deploy using an absolute repo-root path (platform/docs/build) with --no-build and --prod flags, replacing the previous approach of changing into platform/docs and deploying from ./build.

Changes

Netlify Docs Deploy Fix

Layer / File(s) Summary
Netlify deploy step
.github/workflows/build-docs.yml
Deploy command changed to npx netlify-cli deploy --dir=platform/docs/build --prod --no-build; comments added explaining --no-build prevents Netlify from re-running the build via the repo-root netlify.toml.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 Hop hop, no double build today,
The docs deploy won't go astray.
--no-build keeps the right path clear,
No wrong netlify.toml to fear.
This bunny ships the docs with cheer! 🌿

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description provides a clear context statement ('No functional change, just deploy the docs in the newer pnpm world') but leaves all template sections empty, failing to detail the specific changes, testing approach, or environment setup. Complete the 'Changes & Results' section describing the workflow update, add 'Testing' instructions for verifying the Netlify deployment, and fill in the 'Tested Environment' checklist section.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title 'fix: Release deploy of docs' is directly related to the core change—updating the Netlify deployment step in the GitHub Actions workflow to fix docs deployment for the pnpm migration.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/netlify-deploy-directory

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 and usage tips.

@cypress

cypress Bot commented Jun 19, 2026

Copy link
Copy Markdown

Viewers    Run #6397

Run Properties:  status check passed Passed #6397  •  git commit 8ca2647f0f: fix: Release deploy of docs
Project Viewers
Branch Review fix/netlify-deploy-directory
Run status status check passed Passed #6397
Run duration 01m 43s
Commit git commit 8ca2647f0f: fix: Release deploy of docs
Committer Bill Wallace
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 28
View all changes introduced in this branch ↗︎

@wayfarer3130
wayfarer3130 merged commit b59eb30 into master Jun 19, 2026
13 checks passed
@wayfarer3130
wayfarer3130 deleted the fix/netlify-deploy-directory branch June 19, 2026 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant