Skip to content

Fix docs deploy output path and add manual branch dispatch - #615

Merged
mike-parkhill merged 2 commits into
masterfrom
copilot/fix-docs-deployment-workflow
Jul 28, 2026
Merged

mike-parkhill merged 2 commits into
masterfrom
copilot/fix-docs-deployment-workflow

Conversation

Copilot AI commented Jul 28, 2026 •

Copy link
Copy Markdown
Contributor

The docs deploy workflow currently builds mdBook output outside the repository root, while deploy still publishes out/, which leaves /sdk/out missing at deploy time. This updates mdBook to write into repo-local out/ and adds manual dispatch so maintainers can validate the workflow on a branch before merge.

  • Build output path

    • Change the root mdbook script to emit tutorials into out/tutorials under the repository root.
    • Preserve the existing deploy target of FOLDER: out, so the workflow publishes the same top-level docs directory structure without relying on .. path traversal.
  • Workflow trigger

    • Add workflow_dispatch to .github/workflows/docs.yml in addition to the existing push trigger on master.
    • This allows maintainers to run the docs deploy workflow manually against a branch for pre-merge verification.
  • Resulting behavior

    • mdbook now writes where the deploy step already expects artifacts to exist.
{
  "scripts": {
    "mdbook": "mdbook build tutorials --dest-dir out/tutorials"
  }
}

Copilot AI changed the title [WIP] Fix deployment workflow and output path for docs Fix docs deploy output path and add manual branch dispatch Jul 28, 2026
Copilot AI requested a review from mike-parkhill July 28, 2026 19:57
@mike-parkhill
mike-parkhill marked this pull request as ready for review July 28, 2026 20:17
@mike-parkhill
mike-parkhill merged commit c750b13 into master Jul 28, 2026
14 checks passed
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.

3 participants