ReleaseProcess

WMN Release Process

Overview

The WNM 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 date of the release

Steps

The following steps are taken when creating a WNM 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

2. Create release branch

• git branch x.y.z-STAGE-YYYY-MM-DD-branch
  • at this point, the branch is ready for WMO Secretariat updates

3. 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

3. 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

4. Create release zip

# build specification documents
cd standard
make pdf
cd ../kpi
make pdf
cd ..
# setup release
mkdir -p release/x.y
cd release/x.y
mkdir examples kpi schemas standard
cd ../..
cp examples/* release/x.y/examples
cp schemas/wis2-notification-message-bundled.json release/x.y/schemas/wnm-x.y.json
cp standard/wis2-notification-message.pdf release/x.y/standard/wnm-x.y.pdf
cp kpi/wis2-notification-message-kpi.pdf release/x.y/kpi/wis2-notification-message-kpi-x.y.pdf
cd release
zip -r wis2-notification-message-x.y.zip x.y

5. Create a release on GitHub.

• Go to https://github.com/wmo-im/wis2-notification-message/releases
• Click 'Draft a new release'
• Under 'Tag Version' add the relevant release tag (x.y.z)
• Release title should be x.y.z
• TODO: add release description
• Click 'Publish release'
• Send WMO Secretariat a link to the release
• deploy release on schemas.wmo.int server
  • copy zipfile to server
  • cd to directory corresponding to https://schemas.wmo.int/wnm
  • run unzip wnm-x.y.zip