We try to follow a semantic versioning scheme for releases of concepticon-data.
Creating a release comprises the following tasks:
-
Check the list of not linked concepts - with new concept sets some of these could be ticked off!
concepticon notlinked
-
Run bibtool on the references to normalize them for import:
bibtool -r concepticondata/references/bibtool.rsc -o concepticondata/references/references.bib concepticondata/references/references.bib
-
Recreate network data in concept lists (optionally also download raw data again):
concepticon recreate_networks
-
Recreate the statistics pages:
concepticon stats
-
Recreate and push the linking data:
concepticon make_linkdata
-
Check and/or update
metadata.json
(which is read viaclldutils.apilib.API.dataset_metadata
) -
Afterwards, recreate
.zenodo.json
:concepticon citation --version vX.Y.Z
-
Verify that
.zenodo.json
contains the (potentially) updated information frommetadata.json
-
Make sure all changes are pushed and merged into the
master
branch. -
Make sure all tests pass, and also address warnings about missing PDFs (see handling source PDFs)
concepticon test
-
Make sure CLDF-creation works:
cldfbench makecldf cldfbench_concepticon.py --glottolog-version v5.1
-
Adapt
CHANGELOG.md
-
Commit the updates for this version and push updated data:
git commit -a -m"<version> release" git tag -a v<version> -m"release <version>" git push origin git push origin --tags
-
Draft a release via GitHub UI
- picking the correct tag, e.g.
v1.1.0
- using
CLLD Concepticon <version>
as the title - and giving the citation obtained running
concepticon citation
as release description.
- picking the correct tag, e.g.
-
After a while, check on https://zenodo.org for the DOI assigned to the release
- complete the metadata for the release on ZENODO and
- add the DOI badge to the release description on GitHub.
-
Create a new milestone to link to issues for the next version.
-
Create the corresponding CLDF dataset release following the instructions at https://github.com/concepticon/concepticon-cldf/blob/master/RELEASING.md
-
Tweet
Source PDFs for concept lists - like all binary or media content of CLLD databases - are uploaded to CDSTAR. This is done by
- running
concepticon upload_sources
- deleting the uploaded PDF files from
concepticondata/sources
- commiting and pushing the changes in concepticon/concepticon-data
- commiting and pushing the changes in the global media catalog in clld/meta