The GitHub repository

The GitHub platform is the management repository for producing, delivering, historisizing all NUVA artefacts.

This page will not restate all the GitHub features, but give specific information on its use.

GitHub files structure

The GitHub files are organised as follows:

---
config:
  treeView:
    showIcons: true
---
treeView-beta
Units/         ## Source files for core
  Vaccines/
    VACxxxx.yml
  Valences/
    VALxxx.yml
Translations/   ## Source (en) and results for translations
  nuva_xx.yml   ## per language
Alignments/     ## Source files for alignments
   xxx2nuva.csv  ## per code system
docs/           ## Sources for https://nuva.ivci.org
  data/         
    nuvadata.json ## Export of consolidated core data
  documentation/ ## Detailed NUVA documentation
Exports/        ## Artefacts produced from the sources
  CSV/          ## Flat files
    nuva_vaccines_xx.csv
    nuva_valences_xx.csv	
  RDF/          ## RDF graphs
    nuva_core.ttl
    nuva_full.ttl
    nuva_xx.ttl     ## per language
.github/        ## GitHub actions

Source files

Unit files

The unit files describe individual concepts for vaccines and valences.

They are published by the NUVA core maintener.

Having a dedicated file for each concept allows to retrieve the history of changes on this specific concept using the GitHub History button.

Each update of one or several of these files triggers the GitHub actions that will produce the NUVA artifacts.

Translations

The translations folder contains the language files.

The English language file is generated by the GitHub actions when unit files are updated.

The other language files are produced from Weblate by language contributors.

Alignments

The alignment files are provided by alignment contributors. They are reused only for some exports (RDF full export).

Generated files

Consolidated core data

Unit files allow to track easily changes per concept but are not very convenient for tools using the NUVA, including the online NUVA editor.

The GitHub actions generates a reference workfile at docs/data/nuvadata.json each time the unit files are updated.

Exports

Further exports are generated when the source files are changed:

Flat files of vaccines and valences, per language.
RDF graphs.

To be discussed - Include also here the SNOMED Extension publication.

GitHub actions