Add a schema version to JSON #45
Labels
Comments
RyanGlScott
added a commit
that referenced
this issue
Sep 9, 2024
We now include a `"version": "X.Y.Z"` entry in the top-level JSON map that gets generated for each MIR JSON file, where `X.Y.Z` represents the version of the JSON schema that is used to generate the file. Going forward, any changes to the JSON schema will be accompanied by a corresponding schema version bump according to the version bumping principles laid out in [Semantic Versioning](https://semver.org/). Fixes #45.
RyanGlScott
added a commit
that referenced
this issue
Sep 10, 2024
We now include a `"version": <N>` entry in the top-level JSON map that gets generated for each MIR JSON file, where `<N>` represents the version of the JSON schema that is used to generate the file. Going forward, any changes to the JSON schema will be accompanied by a corresponding schema version bump. I have also included some logic in `link_crates` to ensure that all of the crates being linked together use the same schema version. Fixes #45.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
On occasion,
mir-jsonmust make backwards-incompatible changes to the schema it uses for the JSON files that it produces. Ideally, such changes would be readily apparent from the JSON itself so that tools consuming the JSON can fail early, rather than misinterpreting the results of the new schema. To this end, we should add a version number to each JSON file thatmir-jsonproduces that describes which version of the schema is being used.The text was updated successfully, but these errors were encountered: