Skip to content

Publish schema compatibility data - #881

Open
danielgaskins wants to merge 5 commits into
awslabs:mainfrom
danielgaskins:docs/schema-compatibility-data
Open

danielgaskins wants to merge 5 commits into
awslabs:mainfrom
danielgaskins:docs/schema-compatibility-data

Conversation

@danielgaskins

Copy link
Copy Markdown
Contributor

Add a machine-readable schema-compatibility.json alongside the configuration schema and generate the developer-documentation compatibility table from it. The installed schema directory therefore exposes the mapping to downstream tools without requiring them to scrape Markdown.

The documentation workflow now watches schema inputs, and the runtime embed step explicitly includes only the validation schema rather than the new release metadata. This also updates the schema-version check’s stale instruction to point contributors to the changelog.

Tests:

  • julia --project=docs docs/generate_schema_compatibility.jl (including idempotence and malformed-entry checks)
  • julia --project=docs docs/make.jl
  • ./scripts/format-source -jl --dry-run
  • generated-schema CMake script check

Closes #833

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@hughcars
hughcars requested a review from Sbozzolo September 2, 2026 14:14

@hughcars hughcars left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for the PR @danielgaskins, I tried it out and found a few small issues but the basic idea is a nice way to keep things together.

Comment thread docs/generate_schema_compatibility.jl Outdated
Comment thread docs/generate_schema_compatibility.jl Outdated
@Sbozzolo

Sbozzolo commented Sep 3, 2026

Copy link
Copy Markdown
Member

LGTM if @hughcars' comments are addressed

@danielgaskins

Copy link
Copy Markdown
Contributor Author

Updated this branch from current main and added the Palace 0.18.0 / SchemaVer 1-6-0 release boundary to the compatibility data. The generated table matches the JSON, and the CMake embedding check confirms that the metadata is installed but not embedded as a runtime schema.

@hughcars

Copy link
Copy Markdown
Collaborator

Please add a CHANGELOG entry under In progress as well.

@hughcars
hughcars enabled auto-merge September 17, 2026 04:25
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.

Distribute json schema compatibility table in machine-readable file

3 participants