ReleaseProcess

WCMP2 Release Process

Overview

The WCMP2 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 WCMP2 release:

1. Update release version in main branch

• Edit standard/index.adoc
  • update the :version: tag/marker
  • update the :copyright: tag/marker (i.e. 2024-2025, 2024-2026, etc.)
• Edit kpi/index.adoc
  • update the :version: tag/marker
  • update the :copyright: tag/marker (i.e. 2024-2025, 2024-2026, etc.)
• Edit schemas/wcmp2-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/wcmp2-bundled.json

2. Create release tag

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

3. 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/wcmp2-bundled.json release/x.y.z/schemas/wcmp2-bundled.json
cp standard/wcmp2.pdf release/x.y.z/standard/wcmp-x.y.z.pdf
cp kpi/wcmp2-kpi.pdf release/x.y.z/kpi/wcmp-kpi-x.y.z.pdf
cd release
zip -r wcmp-x.y.z.zip x.y.z

4. Deploy release on schemas.wmo.int server

• copy zipfile to server
• cd to directory corresponding to https://schemas.wmo.int/wcmp
• run unzip wcmp-x.y.z.zip

5. Create a release on GitHub.

• Go to https://github.com/wmo-im/wcmp2/releases
• Click 'Draft a new release'
• Under 'Tag Version' add the relevant release tag (x.y.z)
• Release title should be x.y.z
• upload zipfile created in Step 3
• add release description
  • click 'Generate release notes' comparing to previous release
• Click 'Publish release'
• Send WMO Secretariat a link to the release