3.2. METdataio Bugfix Release

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

3.2.1. Open Release Issue

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

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

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

  • For an official or development release, assign the issue to the corresponding METdataio development project.

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

  • Select the target milestone.

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

Using HTTP:

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

cd METdataio

3.2.3. Checkout the Main Branch

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

git checkout main_vX.Y

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

3.2.5. Update Version Number for Release

Update the version number for the bugfix release:

  • For METdataio, 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)

3.2.6. Update Release Notes

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

  • Click on the project that corresponds to support for the release, i.e. METplus Version X.Y Support

  • Navigate to the “Closed Issues” tab. If this tab does not exist, see GitHub Projects to manage support to create it.

  • Find the closed issues with dtcenter/METdataio in the Repository column that have been added since the last bugfix release for METdataio.

  • Open the following URL in a browser:

  • Navigate to the METdataio X.Y.Z Milestone to check for any issues that may not appear in the METplus Version X.Y Support project board.

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

  • Consider organizing release notes into logical groups (e.g. Enhancements, Bugfixes, Documentation, etc.) and modifying GitHub issue titles for consistency. The release notes should match the GitHub issue titles, when possible.

  • Use your best judgement to apply bold formatting for any major or important changes.

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

3.2.7. Merge Release Issue

  • After updating the release-specific content on a release feature branch, submit a pull request to merge those changes back into the source branch.

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

  • Add a link to the release notes from the METdataio User’s Guide, i.e. https://METdataio.readthedocs.io/en/vX.Y.Z-betaN/Users_Guide/release-notes.html (Note: the URL will not be active until the release is created) Refer to a previous release to easily copy and modify this information.

  • Add links to the HTML and PDF versions of the METdataio User’s Guide on ReadTheDocs. https://METdataio.readthedocs.io/_/downloads/en/vX.Y.Z-betaN/pdf/ (Note: the URL will not be active until the release is created) Refer to a previous release to easily copy and modify this information.

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

  • Click on “Publish release”.

3.2.9. Update DTC Website

  • Navigate to https://dtcenter.org and sign in to the Drupal interface.

  • Navigate to the downloads page for the METdataio repository at https://dtcenter.org/community-code/metplus/download

  • Click on the Edit button to 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 “METdataio Version X.Y.Z”.

    • For Related Community Code select both the METplus and the METdataio options (For Macs, hold the Command key to select both).

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

    • Select the release type (Recommended for official or bugfix releases or Development for development versions).

    • 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. Beta releases can use “develop” in the URL, but for official releases, please ensure the link uses the branch name (e.g. main_vX.Y) as opposed to the tag name (e.g. vX.Y.Z). For example, use “https://metplus.readthedocs.io/en/main_vX.Y/Users_Guide/” and NOT “https://metplus.readthedocs.io/en/vX.Y.Z/Users_Guide/

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

    • Update the existing releases, as needed.

      • For a development release, ensure the “Release Type” is set to Development and change any previous Development versions to Other.

      • For a bugfix or official release, change any previous Recommended versions to Other.

      • For an official release, remove the corresponding development releases.

    • Create or edit the “Coordinated METplus Version X.Y” software release.

      • For an official release, create the “Coordinated METplus Version X.Y” release entry if it doesn’t already exist. Ensure the “Release Type” is set to Recommended. Consider changing the “Release Type” of previous coordinated releases from Recommended to Other. Add links for the METdataio X.Y.Z, the METplus “Documentation”, the METplus “Existing Builds and Docker” page, and the “Release Notes”. Make the Release Notes a link to the METdataio Release Notes.

      • For a bugfix release, update the existing link and text in the “Coordinated METplus Version X.Y” release section with the X.Y.Z+1 information.

    • Make any other necessary website updates.

    • Click on “Save”.

3.2.10. 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. ‘METdataio 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.