ReleaseManagement - wmo-im/wcmp-codelists GitHub Wiki

Overview

This document describes workflow on releasing WCMP codelists

  • codelists are managed in CSV files at https://github.com/wmo-im/wmcp-codelists
  • modifications to the codelists should be proposed via a GitHub issue with (at least) the label and addressed to @wmo-im/tt-wismd
  • a branch with the relevant changes should be created corresponding to the issue (i.e. branch created is called issue-xxx, where xxx is the GitHub issue number)
  • once the issue is discussed/has consensus, the branch is merged and the issue is closed
  • on each update to the repository, the ISO Codelist Catalogue XML is automagically generated as part of a GitHub action (trigger). This ensures those looking at the repo can test a working version of the codelist catalogue accordingly
  • when the codelists are ready for a formal release, update the file scripts/wmo-codelist-catalogue.xml.j2 as follows
    • create a new branch (e.g. git checkout -b new-release-x.y.z)
    • add a changelog entry against the new version, i.e. Version x.y.z: dd mm yyyy: description
    • update gmx:versionNumber/gco:CharacterString to new version x.y.z
    • update gmx:versionDate/gco:Date to current date (YYYY-MM-DD)
    • commit changes accordingly (git commit -m 'update release version x.y.z' && git push origin new-release-x.y.z)
    • open a GitHub pull request for review/comment/merge (delete the new-release-x.y.z branch thereafter)
    • create a release tag (git tag -a x.y.z -m 'tagging release x.y.z' && git push --tags)
  • the codelists are now tagged at https://github.com/wmo-im/wmcp-codelists/archive/x.y.z.zip
  • WMO uses this tag to publish the minted version of the codelists to codes.wmo.int and schemas.wmo.int