Commits on Dec 6, 2023

1. Fix ensuring we produce valid jsonschema artifacts for manifest, cata… …

   …log, sources, and run-results (#9155)
   
   * Drop `all_refs=True` from jsonschema-ization build process
   
   Passing `all_refs=True` makes it so that Everything is a ref, even
   the top level schema. In jsonschema land, this essentially makes the
   produced artifact not a full schema, but a fractal object to be included
   in a schema. Thus when `$id` is passed in, jsonschema tools blow up
   because `$id` is for identifying a schema, which we explicitly weren't
   creating. The alternative was to drop the inclusion of `$id`. Howver, we're
   intending to create a schema, and having an `$id` is recommended best
   practice. Additionally since we were intending to create a schema,
   not a fractal, it seemed best to create to full schema.
   
   * Explicity produce jsonschemas using DRAFT_2020_12 dialect
   
   Previously were were implicitly using the `DRAFT_2020_12` dialect through
   mashumaro. It felt wise to begin explicitly specifying this. First, it
   is closest in available mashumaro provided dialects to what we produced
   pre 1.7. Secondly, if mashumaro changes its default for whatever reason
   (say a new dialect is added, and mashumaro moves to that), we don't want
   to automatically inherit that.
   
   * Bump manifest version to v12
   
   Core 1.7 released with manifest v11, and we don't want to be overriding
   that with 1.8. It'd be weird for 1.7 and 1.8 to both have v11 manifests,
   but for them to be different, right?
   
   * Begin including schema dialect specification in produced jsonschema
   
   In jsonschema's documentation they state
   > It's not always easy to tell which draft a JSON Schema is using.
   > You can use the $schema keyword to declare which version of the JSON Schema specification the schema is written to.
   > It's generally good practice to include it, though it is not required.
   
   and
   
   > For brevity, the $schema keyword isn't included in most of the examples in this book, but it should always be used in the real world.
   
   Basically, to know how to parse a schema, it's important to include what
   schema dialect is being used for the schema specification. The change in
   this commit ensures we include that information.
   
   * Create manifest v12 jsonschema specification
   
   * Add change documentation for jsonschema schema production fix
   
   * Bump run-results version to v6
   
   * Generate new v6 run-results jsonschema
   
   * Regenerate catalog v1 and sources v3 with fixed jsonschema production
   
   * Update tests to handle bumped versions of manifest and run-results
   
   (cherry picked from commit 0ab954e)

   

   QMalcolm authored and github-actions[bot] committed Dec 6, 2023
   Configuration menu

   • View commit details
   • Copy full SHA for 30e160e
   • Browse repository at this point

   Copy the full SHA

   30e160e View commit details

   Browse the repository at this point in the history