6.2. METviewer Bugfix Release

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

6.2.1. Open Release Issue

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

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

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

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

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

• Select the target milestone.

6.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/METviewer

Using HTTP:

git clone https://github.com/dtcenter/METviewer

• Enter the project repository directory:

cd METviewer

6.2.3. Checkout the Main Branch

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

git checkout main_vX.Y

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

6.2.5. Update Version Number for Release

Update the version number for the bugfix release:

• For METviewer, the file containing the version number is located at docs/version.

• If the current release is listed as X.Y.Z (major.minor.micro), the bugfix version should be X.Y.Z+1 (i.e. increment the micro value by 1: 1.1.0 becomes 1.1.1)

• In the METviewer/build.xml file, assign the version in the ‘dist’ target

• In the METviewer/vebapp/metviewer/metviewer1.jsp file, assign the version to <div id=’release’> and <title>

6.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/METviewer/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.

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

6.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. METviewer-X.Y.Z-betaN, METviewer-X.Y.Z-rcN, or METviewer-X.Y.Z)

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

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

• If this is a development release, check the box that says “This is a pre-release”

• Click on “Publish release”.

6.2.9. Update DTC Website

• Navigate to the downloads page for the METviewer 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 “METviewer Version X.Y.Z”.

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

  • For Version Label type “METviewer 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 name of the release and the URL should be the release page that was just created under the GitHub Releases tab.

    • 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”.

6.2.10. Finalize Release on GitHub

• Close the GitHub issue for creating this official release.

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

• If necessary, create a new milestone for the next official release (e.g. next vX.Y.Z release).

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

• Close the current milestone.

• Confirm that all existing development projects for the current milestone are closed.

• If necessary, create development projects for the next milestone (e.g. METviewer-X.Y.Z-beta1, beta2, beta3).

• Update the repository settings by resetting the Default branch to the new main_vX.Y branch:

https://github.com/dtcenter/METviewer
-> Settings
-> Branches (tab on left)
-> change the drop down to new branch