[CHORE] Add SCHEMA_PREVIEW build mode + misc. fixes for publishing#297
[CHORE] Add SCHEMA_PREVIEW build mode + misc. fixes for publishing#297John McCall (lowlydba) merged 38 commits intomainfrom
Conversation
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>
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
🗺️ OMF Docs previews are live!
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. 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>
Super-linter summary
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>
Super-linter summary
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>
…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>
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Dana Bauer (danabauer)
left a comment
There was a problem hiding this comment.
Bombs away!
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 (
devbranch) 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
SCHEMA_PREVIEWenvironment variable indocusaurus.config.jsto enable building a schema-only preview, which disables blog, community pages, and unrelated navbar items for faster, focused previews.onBrokenAnchors: 'throw'in the Docusaurus config to fail builds on broken anchors, improving documentation quality.HeroSubtextcomponent inhome.jsxfrom a<p>to a<div>to silence an orphan</p>warning from DocusaurusonBrokenRoutes: 'throw'in the Docusaurus config to fail builds on duplicate routes.docs/guides/placesby renaming the dev-centricREADMEto_READMEso Docusaurus omits it from its buildCI workflow and dependency management updates
package.jsonand integrated thesustainable-npmaction to ensure sustainable (read: fast) package installations in CIpackage.jsonto>=24for compatibility with newer dependencies and workflows (Node 20 is soon EOL in GitHub)yaml-loaderdev dependency frompackage.json.Partially resolves https://github.com/OvertureMaps/schema-wg/issues/416