Skip to content

Releasing JSON schemas

Isak Näslund edited this page Sep 25, 2025 · 5 revisions

For each Beta release of the BHoM the Json schemas should be released by the following steps. The release of schemas needs to include a tweak of the actual JSON files as all refs needs to be updated to point on the new frozen versions. For more information about this, please see the documentation

  1. Run the BHoM alpha installer
  2. Clone and compile repos included in BHoM_JSONSchema but not included in the BHoM_Installer. For a list of repos included in Json schemas, please see Included repositories. At the time of writing this this is:
    • BHoM/dKop_Toolkit
    • BHoM/Test_Toolkit
  3. Clone and build the JSONSchema_Toolkit (develop branch)
  4. Clone the BHoM_JSONSchema repo (develop branch)
  5. Create a branch matching your release (for example v8.3)
  6. Open the .ci/Generation/SchemaGeneration solution
  7. Change the branch to the current release (for example v8.3). Can be found via TODO in view
  8. Build and run the solution code
  9. Inspect the changes made. All schemas should now have been updated for their $id and $ref keywords to now point at the new branch
  10. Run the build and run the unit-test in the .ci folder to check that everything is still validating correctly
  11. Commit and push the code

Clone this wiki locally