search

relaton / support

Internal repository support for Relaton
0 stars 0 forks source link

RNC grammars in relaton-data-* repositories #12

Open CAMOBAP opened 1 year ago

CAMOBAP commented 1 year ago

Intro

Some relaton-model repositories contain only grammar/*.rnc. For example https://github.com/relaton/relaton-model-ietf

Question

Should we add some validation for grammar/*.rnc?

I didn't find exact tool for this, but looks like we can just to rnc to xsd conversion and it will do some kind of validation

Because we use the same https://github.com/relaton/support/blob/master/cimas-config/gh-actions/model/Makefile for all relaton-model-* repos, this will not require mass update

andrew2net commented 1 year ago

@CAMOBAP Nick supports grammars. You should discuss it with him. Ping @opoudjis

CAMOBAP commented 1 year ago

@opoudjis how do you think is it make sense to add some validation workflow for such repos?

opoudjis commented 1 year ago

I have a workflow, which assembles what I need (RNG, not XSD), and as you can imagine, I don't want my workflow disrupted.

The workflow is in https://github.com/metanorma/metanorma-model-iso/blob/main/grammars/make.sh . As you can see, each of these grammars is a git submodule of that repository, and the script extracts the grammars and assembles. If there is an error, I will know about it, because the compilation will fail. A separate script, copy.sh, copies the resulting grammars into the gem for each Metanorma flavour.

So, I already have the grammars generated that I need, and a means of automating that generation.

ronaldtse commented 1 year ago

@opoudjis how do you think is it make sense to add some validation workflow for such repos?

Absolutely makes sense and we should do it.

opoudjis commented 1 year ago

I have no need of this, because, as I've already said, if there is an error in any of the RNC, I will be the first to find out about it when I generate the grammars.

If someone else wants to take some sort of validation workflow on, including @CAMOBAP or @ronaldtse or @andrew2net , be my guest.

andrew2net commented 1 year ago

The relaton-data-* repos store files in YAML format. The RNG grammars can be used to test XML files, not YAML.