6.2. METplotpy Bugfix Release

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

6.2.1. 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/METplotpy

Using HTTP:

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

cd METplotpy

6.2.2. Checkout the Main Branch

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

git checkout main_vX.Y

6.2.3. 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.4. Update Version Number

  • Update the version:

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

6.2.5. 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:

https://github.com/orgs/dtcenter/projects
  • 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/METplotpy in the Repository column that have been added since the last bugfix release for METplotpy.

  • Open the following URL in a browser:

https://github.com/dtcenter/METplotpy/issues
  • Navigate to the METplotpy 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.

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

6.2.7. Create Release on GitHub

  • Ensure that any and all dependent releases for METplotpy have been created according to Release Dependencies.

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

  • For ‘Choose a tag’, create a new tag based on the version, starting with ‘v’ (i.e. vX.Y.Z-betaN, vX.Y.Z-rcN, or vX.Y.Z)

  • Define the ‘Target’ branch as:

    • ‘develop’ for a beta development release

    • ‘main_vX.Y’ for a release candidate, bugfix, or official release

  • Define the ‘Release title’ based on the repository name and version, without a leading ‘v’ (i.e. METplotpy-X.Y.Z-betaN, METplotpy-X.Y.Z-rcN, or METplotpy-X.Y.Z)

  • Add a link to the release notes from the METplotpy User’s Guide, i.e. https://METplotpy.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 METplotpy User’s Guide on ReadTheDocs. https://METplotpy.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”.

6.2.8. Update DTC Website

METplus software releases are announced on the DTC website. Add or update information about software releases on the website.

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

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

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

    • For Version Label type “METplotpy 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:

    • In the Release Notes text box 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.

    • Edit the “Coordinated METplus Version X.Y” software release.

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

    • Make any other necessary website updates.

    • Click on Save at the bottom of the page.

6.2.9. Update Version Lookup Table

Modify the version lookup table in the METplus repository to include the correct version.

Instructions
  • Clone the METplus repository.

    Using SSH:

    git clone git@github.com:dtcenter/METplus
    

    Using HTTP:

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

cd METplus
  • Checkout the develop branch

git checkout develop
  • Create a branch off of develop to update. Include the name of the repository and version in the name.

git checkout -b update_version_vX.Y.Z_repo
  • Open metplus/component_versions.py and increment the version for the appropriate METplotpy entry.

  • Commit change, push to GitHub, and create a pull request to merge change into the develop branch.

6.2.10. Finalize Release on GitHub

Return to GitHub to finalize the details of this release.

Instructions
  • Update milestones:

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

    • Close the current milestone.

    • Create a new milestone for the first bugfix release (e.g. first vX.Y.1 (bugfix) release).

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

  • Update issues:

    • Close the GitHub issue for creating this official release.

    • If necessary, reassign any remaining issues for the current milestone to other milestones.

  • Update projects:

  • Update branches:

    • Remove any remaining stale development branches from the new release.

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

    https://github.com/dtcenter/METplotpy
    -> Settings
    -> Scroll down to the Default branch section
    -> Click the stacked arrows button next to default branch name
    -> Select the new default branch from the dropdown list
    -> Click the Update button