Skip to content

ReleaseProcess

Jump to bottom
Tom Kralidis edited this page Feb 18, 2024 · 10 revisions

WTH Release Process

Overview

The WTH is managed in GitHub as a working area upstream of the WMO publication process.

Release version convention

The convention used is x.y.z-STAGE-YYYY-MM-DD, where:

  • x.y.z is the version (e.g. 2.0.0)
  • STAGE is the stage of the document (DRAFT, FINAL)
  • YYYY-MM-DD is the year month day of the release

Steps

The following steps are taken when creating a WTH release:

  1. Update release version in main branch
  • Edit standard/index.adoc
    • update the :version: tag/marker
  • Commit to main branch
    • git commit -m 'update release version x.y.z-STAGE-YYYY-MM-DD' standard/index.adoc
  1. Create release branch
  • git branch x.y.z-STAGE-YYYY-MM-DD-branch
    • at this point, the branch is ready for WMO Secretariat updates
  1. Apply any WMO updates
  • ensure you are working in the release branch (i.e. x.y.z-STAGE-YYYY-MM-DD) 
    git commit -am 'WMO Secretariat updates'
git push origin x.y.z-STAGE-YYYY-MM-DD-branch
  1. Create release tag
  • ensure you are working in the release branch (i.e. x.y.z-STAGE-YYYY-MM-DD) 
    git tag -a x.y.z-STAGE-YYYY-MM-DD -m 'tagging release x.y.z-STAGE-YYYY-MM-DD'
git push --tags
  1. Create release zip
# build specification document
cd standard
make pdf
cd ..
# build bundle
python3 scripts/generate-bundle.py
zip -j /tmp/wth-bundle.zip topic-hierarchy/*.csv
# setup release
mkdir -p release/n
cd release/n
mkdir standard bundle
cd ../..
cp /tmp/wth-bundle.zip release/n/bundle/wth-n.zip
cp standard/wis2-topic-hierarchy.pdf release/n/standard/wth-n.pdf
cd release
zip -r wis2-topic-hierarchy-n.zip n
  1. Create a release on GitHub.
  • Go to https://github.com/wmo-im/wis2-topic-hierarchy/releases
  • Click 'Draft a new release'
  • Under 'Tag Version' add the relevant release tag (n)
  • Release title should be n
  • TODO: add release description
  • Click 'Publish release'
  • Send WMO Secretariat a link to the release
  • deploy release on schemas.wmo.int server
Clone this wiki locally