Skip to content

Commit

Permalink
Merge pull request ome#136 from sbesson/json_schema_release
Browse files Browse the repository at this point in the history
Add section about JSON schemas
  • Loading branch information
sbesson authored Aug 29, 2022
2 parents 65289c6 + 439c86c commit 12c916b
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,26 @@ Commits on GitHub can be viewed using web services from the W3C:
* Update changelog at the bottom of `latest/index.bs`
* Find references to previous version and _in most cases_, bump to the current version.

## JSON schemas

For each top-level metadata key of the OME-NGFF specification, JSON schemas are maintained
for each version of the specification and stored under `$VERSION/schemas/` or `latest/schemas/`.
Tests validating these schemas must be implemented to follow principles of the
[JSON schema test suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite)
and stored under `$VERSION/tests/` or `latest/tests/` to allow their execution on each CI build.

All official example snippets must also be extracted and managed as separate JSON files under
`$VERSION/examples/` or `latest/examples/`, validated by the appropriate schema by adding a
`.config.json` file specifying the JSON schema to use and included in the
specification document using the
[include-code](https://tabatkins.github.io/bikeshed/#including-code) directive.

The official OME-NGFF JSON schemas are published under
https://ngff.openmicroscopy.org/<version>/schemas/<schema_name>.schema using the
[Spec prod](https://github.com/ome/spec-prod) GitHub action. When a new JSON schema is introduced,
this action needs to be reviewed to update the deployment script and allow the publication
of the schema.

# Release process

* copy `latest/index.bs` to `$VERSION/index.bs`
Expand All @@ -43,7 +63,7 @@ Commits on GitHub can be viewed using web services from the W3C:
* Version in the citation block including release date
* Update https://github.com/ome/spec-prod for the new version

## Citing
# Citing

Please see https://ngff.openmicroscopy.org/latest#citing for the latest
citation.

0 comments on commit 12c916b

Please sign in to comment.