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, where x.y.z is the version (e.g. 2.0.0)

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
• Edit kpi/index.adoc
  • update the :version: tag/marker
• Edit schemas/wis2-notification-message-bundled.json
  • update the $id property
• Commit to main branch
  • git commit -m 'update release version x.y.z' standard/index.adoc kpi/index.adoc schemas/wis2-notification-message-bundled.json

2. Create release tag

• ensure you are working in the release branch (i.e. x.y.z)

  git tag -a x.y.z -m 'tagging release x.y.z'
  git push --tags

3. Create README.txt

Create the following file in /tmp/README.txt:

This directory contains the following artifacts for the WIS2 Notification Message (WNM), version x.y.z (draft):

- examples: Informative examples of WNM records
- kpis: Informative key performance indicators to evaluate WNM records
- schemas: Normative JSON Schema for validating WNM records
- standard: Draft PDF copy of the standard with Abstract Test Suite (ATS)
- Zip file of the above artifacts 

The official standard will be published in the Manual on the WMO Information System (WMO-No. 1060), Volume II, Appendix E. 
[https://library.wmo.int/idurl/4/68731]. 

The official codelists will be published at https://codes.wmo.int/wis/.

4. Create release zip

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

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