Skip to content

[CHORE] Add SCHEMA_PREVIEW build mode + misc. fixes for publishing#297

Merged
John McCall (lowlydba) merged 38 commits intomainfrom
jmccall-schema-docs-builds
Mar 18, 2026
Merged

[CHORE] Add SCHEMA_PREVIEW build mode + misc. fixes for publishing#297
John McCall (lowlydba) merged 38 commits intomainfrom
jmccall-schema-docs-builds

Conversation

@lowlydba
Copy link
Contributor

@lowlydba John McCall (lowlydba) commented Mar 16, 2026

This is groundwork to enable both the schema and docs repos to build branch deploy previews that contain each others' latest content (https://github.com/OvertureMaps/schema-wg/issues/416). This PR must be merged before that one can be updated and made ready to land.

After merging, docs preview builds will automagically include the latest schema docs (dev branch) and deploy a version using the local schema documents from the repository. This is to allow easy A/B testing until we have full confidence in the auto-generated docs.

The production deploy will still use the local schema/reference/* docs to build.

Changes

Docusaurus configuration improvements

  • Added support for a SCHEMA_PREVIEW environment variable in docusaurus.config.js to enable building a schema-only preview, which disables blog, community pages, and unrelated navbar items for faster, focused previews.
  • Set onBrokenAnchors: 'throw' in the Docusaurus config to fail builds on broken anchors, improving documentation quality.
    • Broken anchor links were also fixed as part of this
  • Changed the HeroSubtext component in home.jsx from a <p> to a <div> to silence an orphan </p> warning from Docusaurus
  • Set onBrokenRoutes: 'throw' in the Docusaurus config to fail builds on duplicate routes.
    • Fixed the existing duplicate path for docs/guides/places by renaming the dev-centric README to _README so Docusaurus omits it from its build

CI workflow and dependency management updates

  • Added npm dependency management to Dependabot configuration for automated updates, with custom labels and commit message formatting.
  • Updated CI workflows to set up Node.js using the version specified in package.json and integrated the sustainable-npm action to ensure sustainable (read: fast) package installations in CI
  • Updated the required Node.js version in package.json to >=24 for compatibility with newer dependencies and workflows (Node 20 is soon EOL in GitHub)
  • Removed the unused yaml-loader dev dependency from package.json.

Partially resolves https://github.com/OvertureMaps/schema-wg/issues/416

Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Read Node version from package.json instead of hardcoding '24', add a pinned lowlydba/sustainable-npm action to configure the npm environment, and replace `npm install --prefer-dedupe` with `npm ci --prefer-dedupe` for deterministic installs. Build step remains unchanged.

Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
@github-actions
Copy link

Super-linter summary

Language Validation result
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
SQLFLUFF Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@github-actions
Copy link

github-actions bot commented Mar 16, 2026

🗺️ OMF Docs previews are live!

🆕 Auto-gen schema site (beta) https://staging.overturemaps.org/docs/pr/297/index.html
🗂️ Auto-gen schema ref dev@ac45fe7
🌍 Repo schema site https://staging.overturemaps.org/docs/pr/297-no-autogen/index.html
🕐 Updated Mar 18, 2026 21:05 UTC
📝 Commit 7aaf415

Auto-gen schema site is now available. This is an early preview of a future workflow where we will automatically generate and publish reference docs for the Overture Maps Format schema with every change to the schema repo.
The auto-gen schema site may contain incomplete or inaccurate information as we are still refining the generation process, so please compare against the repo schema site and refer to the linked commit for the most up-to-date source of truth.

Note

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

Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Enable Docusaurus to throw on duplicate routes by adding onDuplicateRoutes: 'throw' to docusaurus.config.js. Rename docs/guides/places/README.md to docs/guides/places/_README.md to reorganize the guide file (prevents it from being treated as the default index page).

Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
@github-actions
Copy link

Super-linter summary

Language Validation result
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
SQLFLUFF Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
@github-actions
Copy link

Super-linter summary

Language Validation result
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
SQLFLUFF Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Signed-off-by: John McCall <john@overturemaps.org>
…ureMaps/docs into jmccall-schema-docs-builds

Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
@github-actions
Copy link

Super-linter summary

Language Validation result
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
SQLFLUFF Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Copy link
Collaborator

@danabauer Dana Bauer (danabauer) left a comment

Choose a reason for hiding this comment

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

Bombs away!

@lowlydba John McCall (lowlydba) merged commit 21e0c97 into main Mar 18, 2026
12 checks passed
@lowlydba John McCall (lowlydba) deleted the jmccall-schema-docs-builds branch March 18, 2026 21:14
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.

4 participants