Move schema.json from validation to docs
#232
Conversation
This allows the JSON schema to be published alongside the rest of the documentation to GitHub pages. The schema will be available at https://ossf.github.io/osv-schema/schema.json. Also created a symlink to the previous repository location of `validation/schema.json` in case anyone is already using that in a `$schema` property Closes ossf#226 Signed-off-by: Jamie Magee <[email protected]>
| @@ -0,0 +1,313 @@ | |||
| { | |||
There was a problem hiding this comment.
Would validation/schema.json being a symlink break existing users depending on the https://raw.githubusercontent.com/ossf/osv-schema/main/validation/schema.json link ?
What if we made the docs/schema.json a symlink instead to this instead?
There was a problem hiding this comment.
I just checked and it doesn't work 😢 https://raw.githubusercontent.com/JamieMagee/osv-schema/github-pages-schema/validation/schema.json
Unfortunately doing it the other way round doesn't work either. What do you think about duplicating the file? Or just having it in docs?
There was a problem hiding this comment.
darn :/
Re "other way around doesn't work": do you mean having validation/schema.json be the source of truth, and having docs/schema.json as a symlink doesn't work either when it comes to the GitHub site generation?
Interestingly, it seems to work here: https://github.com/s4y/gh-pages-symlink-test
This allows the JSON schema to be published alongside the rest of the documentation to GitHub pages. The schema will be available at https://ossf.github.io/osv-schema/schema.json.
Also created a symlink to the previous repository location of
validation/schema.jsonin case anyone is already using that in a$schemapropertyCloses #226