Feature #2562 version lookup documentation and automated tests

[georgemccabe]

Change Summary

• Update Release Guides to include information on how to update the version lookup table
• Update Contributor's Guide to include information on how to use version lookup script
• Added stubs for Contributor's Guide descriptions of METplus utility scripts
• Updated automated use case test scripts to use version lookup script instead of relying on manage_externals
• Clean up some automated test scripts to satisfy SonarQube complaints

Pull Request Testing

• Describe testing already performed for these changes:
  

• Ran a few use case groups that use METplotpy and METdataio to ensure that changes to automated test scripts still work
• Reviewed documentation edits for clarify and formatting

• Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:
  

• Review Contributor's Guide updates: https://metplus.readthedocs.io/en/feature_2562_ext_version/Contributors_Guide/utilities.html
• Review Bugfix Release Guide updates: https://metplus.readthedocs.io/en/feature_2562_ext_version/Release_Guide/met_bugfix.html#update-version-lookup-table
• Review METplus Official Release Guide updates: https://metplus.readthedocs.io/en/feature_2562_ext_version/Release_Guide/metplus_official.html#add-next-version-to-lookup-table

• Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]

• Do these changes include sufficient testing updates? [Yes]

• Will this PR result in changes to the test suite? [No]
  
  If yes, describe the new output and/or changes to the existing output:
  

• Do these changes introduce new SonarQube findings? [No]
  
  If yes, please describe:

• Please complete this pull request review by 11/8/2024.
  

Pull Request Checklist

See the METplus Workflow for details.

• Add any new Python packages to the METplus Components Python Requirements table.
• For any new datasets, an entry to the METplus Verification Datasets Guide.
• Review the source issue metadata (required labels, projects, and milestone).
• Complete the PR definition above.
• Ensure the PR title matches the feature or bugfix branch name.
• Define the PR metadata, as permissions allow.
  Select: Reviewer(s) and Development issue
  Select: Milestone as the version that will include these changes
  Select: Coordinated METplus-X.Y Support project for bugfix releases or METplus-Wrappers-X.Y.Z Development project for official releases
• After submitting the PR, select the ⚙️ icon in the Development section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
• After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
• Close the linked issue and delete your feature or bugfix branch from GitHub.

[jprestop]

@georgemccabe I'm trying to wrap my head around this. I see in the bugfix documentation it says to check out develop, and I understand why that would be. But, do we also want to update the main version of metplus/component_versions.py during a bugfix releease?

[jprestop]

@georgemccabe Also, I'll note that the add_next_version_to_lookup.rst file text assumes that the METplus components will always cut a X.0.0 release and then cut a X.1.0 release and then cut a X+1.0.0 release, which may or may not be the case, but it seems simplest to leave as-is, since that it is likely, an account for exceptions as we go along. Is that what you and @JohnHalleyGotway were thinking too?

[georgemccabe]

@jprestop, I believe we discussed that any logic used to obtain version info would download the script from the develop branch to ensure it is maintained in one place. This idea sounds good in theory, but the details depend on how the script is eventually used and may need to change. If we start using this script and determine that we do need to have an updated list in the main_vX.Y branch, we would need to update these instructions to update the numbers in both main_vX.Y and develop.

@georgemccabe I'm trying to wrap my head around this. I see in the bugfix documentation it says to check out develop, and I understand why that would be. But, do we also want to update the main version of metplus/component_versions.py during a bugfix releease?

[georgemccabe]

So far that has been the case and aligns with our current development cycle of 2 releases per year: X.0 and X.1. If this process changes, we will likely have to review more than just this instruction for accuracy.

@georgemccabe Also, I'll note that the add_next_version_to_lookup.rst file text assumes that the METplus components will always cut a X.0.0 release and then cut a X.1.0 release and then cut a X+1.0.0 release, which may or may not be the case, but it seems simplest to leave as-is, since that it is likely, an account for exceptions as we go along. Is that what you and @JohnHalleyGotway were thinking too?

[jprestop]

Thanks for all of your work on this task and for the discussion. I have reviewed the documentation and ensured that all tests passed. I approve this request.

[jprestop]

@georgemccabe I hope you don't mind but I'm going to squash and merge this now, so I can pull these changes into the branch I am working on now. I did not, however, delete your branch, in case you still need it for some reason. Feel free to delete when you're ready.