search

dracor-org / einakter

Database of German one-act plays
MIT License
3 stars 1 forks source link

Attach JSON and CSV datasets to GitHub releases #171

Open v-ji opened 1 week ago

v-ji commented 1 week ago

Seeing as the CSV and JSON dataset outputs are static, we could think about attaching them as assets to each GitHub release.

This would aid in reproducibility, as there is currently no way to reference or fetch the JSON/CSV representation of the dataset of a particular version. The stable URL assigned to the release assets by GitHub could for example be used by executable papers to ensure consistent results.

It would probably make sense to generate and attach the assets automatically via Actions.

Alternatives considered
Git checkout: While it is possible to check out any commit or tag and access the raw data.yaml, this method lacks year normalisation and other variables.

cmil commented 2 days ago

I implemented a workflow that attaches the JSON and CSV files to the release. See https://github.com/dracor-org/einakter/releases/tag/v1.5.0-beta.1 as an example.