This repository includes a set of resources used to generate CodeMeta files using the ShExML language. These workflows should be treated as examples and therefore they should be adapted to your own use cases.
- crosswalks: Implements three workflows defined on the CodeMeta website for Maven, Zenodo and Github.
- shexml-codemeta: This is the workflow followed to generate a CodeMeta file for the ShExML engine. It uses some parts of the previously defined workflows but it is heavily customised to fit the purpose of the ShExML repository.
- dmaog-codemeta: This is the workflow followed to generate a CodeMeta file for DMAOG. It uses some parts of the previously defined workflows but it is heavily customised to fit the purpose of the DMAOG repository.
All the folders contain a generate-codemeta.sh script which encapsulates the different generation steps. Therefore, you should call it using the following command:
$ bash generate-codemeta.sh
The script will download the latest version of ShExML and will run all the existing mapping rules (files ending in .shexml) in the directory. This generates a non-framed JSON-LD CodeMeta. In order to have it validated against the existing CodeMeta validator the script will convert all the non-framed results to their framed JSON-LD counterpart. This is achieved using the convertToFramedJsonLD.groovy script.
You can differentiate between non-framed and framed JSON-LD results looking to the extension of the generated file: .jsonld refers to the non-framed version and .json to the framed one.
| Tool | Version |
|---|---|
| JDK | 17.x |
| Groovy | 4.0.x |
| Bash | 5.1.x |
These libraries are downloaded during the execution:
| Library | Version |
|---|---|
| ShExML | 0.5.4 |
| Apache Jena | 5.5.0 |
This work has been funded by a cascading grant entitled "2nd open call for Route 2 support - #1 Assessing and improving Research Software" provided by the FAIR-IMPACT project which, in turn, has received funding from the European Commission’s Horizon Europe funding programme for research and innovation programme under the Grant Agreement no. 101057344. The content of this repository does not represent the opinion of the European Commission, and the European Commission is not responsible for any use that might be made of such content.