Skip to content

Latest commit

 

History

History
144 lines (125 loc) · 4.36 KB

RELEASING.md

File metadata and controls

144 lines (125 loc) · 4.36 KB

Releasing glottolog/glottolog

Preparations

  • Make sure you have the latest ISO 639-3 code tables from https://iso639-3.sil.org/code_tables/download_tables put into build/,
  • Check out master, pull the latest changes: 
    git checkout master
git pull origin master
  • Check the tree and references running 
    glottolog-admin check
    making sure there are no ÈRRORs

Creating the release PR

  • Check out a new branch: 
    git checkout -b release-<version>
  • Update
    • CHANGES.md
    • CONTRIBUTORS.md
    • config/publication.ini adding a proper version number
  • Run 
    glottolog-admin update
    and make sure the data can be loaded into treedb: 
    cd ../treedb
git checkout master
git pull origin
~/venvs/glottolog/bin/python -c "import treedb; treedb.load(); treedb.write_csv()"
cd ../glottolog
  • Update automatically created BibTeX files:
    • iso6393.bib: Run glottolog-admin isobib
    • elpub.bib: Run glottolog-admin elpubbib
    • grambank.bib: Run glottolog-admin grambankbib <URL> passing the GitHub URL to the latest released version of https://github.com/grambank/grambank/blob/master/cldf/sources.bib
    • evobib.bib:
    • dplace.bib: Run glottolog-admin updatebib dplace
    • benjamins.bib:
      • Switch to the clone of glottolog/benjamins
      • Pull the latest changes via FTP
      • Recreate benjamins.bib, running python to_bib.py
      • Switch back to glottolog/glottolog
      • Run glottolog-admin updatebib benjamins PATH/TO/benjamins/benjamins.bib
    • langsci.bib:
      • Update the raw_texfiles repos, see https://github.com/langsci/raw_texfiles#readme
      • Recreate the merged bib: linglit mergedbib langsci cldf_datasets/imtvault/raw/langsci/ > langsci.bib
      • Run glottolog-admin updatebib langsci PATH/TO/langsci.bib
    • glossa.bib:
      • Update the glossa repos via linglit update glossa PATH/TO/REPOS
      • Recreate the merged bib: linglit mergedbib glossa PATH/TO/REPOS > glossa.bib
      • Update the refprovider: glottolog-admin updatebib glossa PATH/TO/glossa.bib
    • ldh.bib:
    • jocp.bib:
      • Sync the Zotero group library and export to BibTeX.
      • Run glottolog-admin updatebib jocp PATH/TO/ZOTERO_EXPORT --merge
  • Run glottolog-admin bib to create build/monster-utf8.bib - about 30mins
  • Run 
    glottolog-admin update
  • Run 
    glottolog-admin release
git commit -a -m"release <version>"
git push origin release-<version>
  • Create a corresponding PR on GitHub

Releasing

Upon approval of the PR:

  • Merge the release PR into master 
    gh pr checkout <#>
gh pr review
gh pr merge
git pull origin
git tag -a v<version> -m "release <version>"
  • Push the tag to origin: 
    git push --tags origin
  • Create corresponding release of glottolog-cldf, see https://github.com/glottolog/glottolog-cldf/blob/master/RELEASING.md
  • Back to ../glottolog
  • Re-set the version number to dev mode, by incrementing and adding .dev0:
    • config/publication.ini
  • Create "proper" releases on GitHub and have it picked up by ZENODO.
  • Add DOI badges from ZENODO as soon as they become available.
  • Close fixed issues.

Checking a pull request

  1. Update the master branch and store languoid stats: 
    git checkout master
git pull origin
glottolog-admin writelanguoidstats
  2. Check out the PR branch and run the checks: 
    git checkout <BRANCH>
glottolog-admin check --old-languoids
  3. If necessary, run glottolog-admin updatesources and continue with 2.

Troubleshooting

If glottolog-admin bib fails at

  File "/home/forkel/venvs/glottolog/pyglottolog/src/pyglottolog/references/bibfiles_db.py", line 559, in assign_ids
    assert Entry.allhash(conn)
AssertionError

check the bad entries in build/bibfiles.sqlite3:

sqlite> select * from entry where hash is null;
292775|21|hw:Nigam:Andhra-Pradesh||||

This can be due to malformed BibTeX entries - and correspondingly must be fixed in the BibTeX before re-running glottolog-admin bib --rebuild.