Skip to content

fix: correct schema docs output path in PR preview workflow - #756

Merged
John McCall (lowlydba) merged 1 commit into
mainfrom
lowlydba-fix-schema-pr-preview-docs-path
Sep 21, 2026
Merged

John McCall (lowlydba) merged 1 commit into
mainfrom
lowlydba-fix-schema-pr-preview-docs-path

Conversation

@lowlydba

@lowlydba John McCall (lowlydba) commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The Generate schema markdown docs step in .github/workflows/schema-pr-preview.yml still writes to docs/schema/reference, a path that predates the docs repo's schema docs instance move. OvertureMaps/docs#512 introduced a dedicated Docusaurus plugin instance for schema docs (id schema, path schema/, routeBasePath schema), so the generated markdown now needs to land at schema/reference instead.

This PR updates the output-dir to ${{ github.workspace }}/${{ env.DOCS_PATH }}/schema/reference, matching that new layout.

Fixes #755.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Signed-off-by: John McCall <john@overturemaps.org>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

The workflow path matches the docs repository’s schema plugin layout; only the PR description’s companion-issue wording needs correction.

Review effort: Lite
Findings: 1 Low severity

Open (1)
What changed in this PR

Updates the schema PR preview workflow to generate docs into the relocated Docusaurus schema instance.

Changes:

  • Changes output path from _docs/docs/schema/reference to _docs/schema/reference.
File Description
.github/​workflows/​schema-pr-preview.yml Corrects schema documentation output location.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/workflows/schema-pr-preview.yml
@github-actions

Copy link
Copy Markdown

🗺️ Schema reference docs preview is live!

🌍 Preview https://staging.overturemaps.org/schema/pr/756/schema/index.html
🕐 Updated Sep 21, 2026 17:23 UTC
📝 Commit c6c756f
🔧 env SCHEMA_PREVIEW true

Note

♻️ This preview updates automatically with each push to this PR.

@lowlydba
John McCall (lowlydba) merged commit d9f7ab2 into main Sep 21, 2026
34 of 36 checks passed
@lowlydba
John McCall (lowlydba) deleted the lowlydba-fix-schema-pr-preview-docs-path branch September 21, 2026 17:56

This branch was successfully deployed

1 active deployment
staging — c6c756f6 Deployed Sep 21, 2026 by lowlydba via Deploy #568
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG](ci) Schema PR preview generates docs to the pre-#512 path, leaving the schema sidebar empty

4 participants