phenopacket-format icon indicating copy to clipboard operation
phenopacket-format copied to clipboard

Add version info to JSON Schema, and implement a procedure to ensure in sync with reference implementation

Open cmungall opened this issue 9 years ago • 3 comments

Currently the JSON-Schema is purely derived. The procedure is to run SchemaGeneratorTest in the reference implementation. The Makefile in this repo copies this across. This is potentially confusing, things can get out of sync.

  • The JSON-Schema should be tagged with version info, and this should sync'd with the reference implementation release on mvn central
  • There should be a proper maven assembly target to generate the schema in the target/directory. Should this be part of the release?
  • The format and reference repos should be better synced.
  • The overall process should be better documented. We have minimal docs here: https://github.com/phenopackets/phenopacket-format/wiki/JSON-Schema

In many ways a merger of the two repos might make some of this easier

cmungall avatar Apr 04 '16 19:04 cmungall

@cmungall. Thanks. Agreed that some cleanup might be helpful. for now, it seems like the workflow should be as follows:

  1. mvn package on the reference implementation repository
  2. in phenopacket-format run make (or make json-schemas).

Is this correct? How does one run SchemaGeneratorTest and is it needed given the above?

harryhoch avatar Apr 04 '16 19:04 harryhoch

Yes, that's right

I run SchemaGeneratorTest from within eclipse, but you can just do mvn test.

cmungall avatar Apr 04 '16 19:04 cmungall

got it. thanks

harryhoch avatar Apr 04 '16 21:04 harryhoch