openCypher icon indicating copy to clipboard operation
openCypher copied to clipboard

Commit the .ebnf output into the repo

Open jacobfriedman opened this issue 3 years ago • 1 comments

Please include the generated opencypher EBNF file in the repo

Otherwise, for those relying on the .ebnf file, for every update in the grammar those people would have to regenerate the file and check the diff.

jacobfriedman avatar Aug 12 '22 17:08 jacobfriedman

Thanks for using with the openCypher artifacts.

It is a general practice of the openCypher repo to not include built artifacts. Exceptions to that rules require very good reason.

The reason you are providing is not convincing. I do not see why you have to check the diff of a rebuilt EBNF. Why not just using the regenerate EBNF? Conversely, if the actual EBNF diff is an essential input to your usage of the grammar and if we would include the EBNF into the repo, then you would still will have the obtain the diff of the EBNF. So, I can not see any benefit regarding the diff.

If it is the regeneration of the EBNF, i.e. running the build, that bothers you, I am afraid I can not help you either. The repo contains the source code and not the generated artifacts. The generated artifacts are released in milestones. This gives you two options to chose from:

  • If you prefer to not running the build yourself, you can rely on the milestone releases, which gives you the generated artifacts directly. Check the opencypher.org/resources for that.
  • If you prefer to see in between release version of the grammar, you will have to bother with building the artifacts yourself.

hvub avatar Aug 30 '22 12:08 hvub