2.2. MET Bugfix Release

Create a new vX.Y.Z bugfix release from the main_vX.Y branch.

2.2.1. Open Release Issue

  • Define a new issue in the MET repository to create the new release.

    • “Create the MET vX.Y.Z release” for an official or bugfix release.

    • “Create the MET vX.Y.Z-betaN (or -rcN) release” for a development release.

  • For an official or development release, assign the issue to the current MET development project.

  • For a bugfix release, assign the issue to the organization level support project.

  • Select the target milestone.

2.2.2. Clone the Project Repository

  • Create and work in a new directory to ensure a fresh environment:

mkdir release-X.Y.Z
cd release-X.Y.Z
  • Run the clone command to obtain the repository.

Using SSH:

git clone git@github.com:dtcenter/MET

Using HTTP:

git clone https://github.com/dtcenter/MET
  • Enter the project repository directory:

cd MET

2.2.3. Checkout the Main Branch

Checkout the main branch for the X.Y release. If you are creating the MET-X.Y.Z bugfix release, checkout main_vX.Y.

git checkout main_vX.Y

2.2.4. Create Release Feature Branch

  • Create a feature branch in which to update the version number and add release notes being sure to include the GitHub issue number for the new release.

git checkout -b feature_NNNN_vX.Y.Z       # for an official or bugfix release
git checkout -b feature_NNNN_vX.Y.Z-betaN # for a development release
git checkout -b feature_NNNN_vX.Y.Z-rcN   # for a development release

2.2.5. Update Version Number

  • Update the version in the code and documentation:

    • Update the met_version variable in met/src/basic/vx_util/util_constants.h which defines the version number written to the MET output files.

    • In met/docs/conf.py, update the version, release_year, and release_date variables for the documentation.

    • DO NOT update the version number listed in the MET configuration files, add a new table file, or add a new test header file.

2.2.6. Update Release Notes

You can refer to the GitHub Issues page to see what has changed for this release. Open the following URL in a browser:

https://github.com/dtcenter/MET/issues
  • Click on the Projects tab and select the project (under Repository) that corresponds to the release you are creating.

  • Update the release-notes.rst file found in the User’s Guide directory.

  • When creating a bugfix release, leave the “Version X.Y.0 release notes (YYYYMMDD)” in place, along with any other bugfix release notes and add a section above for the latest bugfix release (i.e. “Version X.Y.Z release notes (YYYYMMDD)”).

  • Commit changes and push to GitHub.

2.2.7. Merge Release Issue

  • After updating the version number and release notes on a release feature branch, submit a pull request to merge those changes back into the source branch.

2.2.8. Create Release on GitHub

  • Go to Releases on GitHub and click ‘Draft a new release’

  • Set the tag based on the version, starting with ‘v’, i.e. vX.Y.Z-betaN, vX.Y.Z-rcN, or vX.Y.Z

  • Set the branch value to ‘develop’ for a development release or ‘main_vX.Y’ for a bugfix or official release

  • Choose a release name (i.e. MET-X.Y.Z-betaN, MET-X.Y.Z-rcN, or MET-X.Y.Z)

  • Add a link to the release notes from the MET User’s Guide

  • Attach a PDF of the MET User’s Guide, if available

2.2.9. Attach Release Tarfile

  • The MET software is distributed as a tarfile, but not the one created by GitHub. On a project machine (e.g. kiowa), clone the MET repository and run a script to build the tarfile for the newly tagged release.

git clone https://github.com/dtcenter/MET
MET/scripts/build/met_checkout_and_build.sh tag vX.Y.Z
  • Edit the vX.Y.Z release on GitHub by uploading the resulting tar file (met-X.Y.Z.YYYYMMDD.tar.gz) as a release asset.

2.2.10. Update DTC Website

  • Navigate to the downloads page for the MET repository at www.dtcenter.org.

  • Sign in to the Drupal interface and edit the Downloads page.

  • Create a new Software Release for the newly released version by clicking on Add New Release.

    • For Full Title of Release type “MET Version X.Y.Z”.

    • For Related Community Code select both the METplus and the MET options (use shift to select).

    • For Version Label type “MET X.Y.Z betaN”.

    • Select the release type (Recommended for official or bugfix releases or Development for development versions). If necessary, change previously Recommended versions to Other.

    • Enter the release date.

    • Click on Add Code Download then click Add Link to add links for each of the following:

      • Add Link: Link text should be the file name of the tar file and the URL should be the .tar.gz file created in the “Attach Release Tarfile” step.

      • Add Link: Link text should be “User’s Guide” and the URL should be the top level directory of the User’s Guide hosted on the web.

      • Add Link: Link text should be “Existing Builds and Docker” and the URL should be the latest Existing Builds page, i.e. https://dtcenter.org/community-code/metplus/metplus-4-0-existing-builds (If creating a new official release, be sure to add a new Existing Builds and Docker page, if one was not already created.)

    • Inside the text box in the “Release Notes” section provide a direct link to the release-notes.html file in the User’s Guide.

    • Click on “Create Release”.

    • Click on “Save”.

2.2.11. Finalize Release on GitHub

  • Close the GitHub issue for creating this bugfix release.

  • Edit the milestone for the current release by updating the Due date with the actual release date.

  • Create a new milestone for the next bugfix release (e.g. ‘MET X.Y.{Z+1} (bugfix)’).

  • If necessary, reassign any remaining issues for the current bugfix milestone to the next one.

  • Close the current bugfix milestone.