Refactor the METplus SonarQube workflow with a custom action

[JohnHalleyGotway]

Describe the Enhancement

During the METplus 6.0.0 beta4 development cycle, a SonarQube scanning workflow (.github/workflows/sonarqube.yml) was added to the METplus repositories. While the MET logic is complex and requires running the SonarQube build wrapper in a Docker container, the logic for the Python-based METplus repositories is straight-forward. As of beta4, the same set of 5 workflow steps (checkout, branch name, configure, run scan, check quality gate) is repeated in the METplus, METplotpy, METcalcpy, and METdataio repositories. Note that the SonarQube workflow has not yet been added to METviewer, and the logic for doing so has not yet beed defined.

This issue is define a custom action in a new dtcenter/metplus-action-sonarqube repository. That action should perform the 5 steps defined above: checkout, branch name, configure, run scan, check quality gate

Then update the existing sonarqube.xml workflows to call that custom action instead. This should provide a more maintainable solution.

Time Estimate

2 days.

Sub-Issues

Consider breaking the enhancement down into sub-issues.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

METplus Air Force key (2771024)

Define the Metadata

Assignee

• Select engineer(s) or no engineer required
• Select scientist(s) or no scientist required

Labels

• Select component(s)
• Select priority
• Select requestor(s)

Projects and Milestone

• Select Repository and/or Organization level Project(s) or add alert: NEED CYCLE ASSIGNMENT label
• Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

• METplus, MET, METdataio, METviewer, METexpress, METcalcpy, METplotpy
  None needed at this time. Plan to define the task in this one issue and then link PR's for the other repos to this issue.

Enhancement Checklist

See the METplus Workflow for details.

• Complete the issue definition above, including the Time Estimate and Funding Source.
• Fork this repository or create a branch of develop.
  Branch name: feature_<Issue Number>_<Description>
• Complete the development and test your changes.
• Add/update log messages for easier debugging.
• Add/update unit tests.
• Add/update documentation.
• Add any new Python packages to the METplus Components Python Requirements table.
• Push local changes to GitHub.
• Submit a pull request to merge into develop.
  Pull request: feature <Issue Number> <Description>
• Define the pull request metadata, as permissions allow.
  Select: Reviewer(s) and Development issues
  Select: Repository level development cycle Project for the next official release
  Select: Milestone as the next official version
• Iterate until the reviewer(s) accept and merge your changes.
• Delete your fork or branch.
• Close this issue.

[JohnHalleyGotway]

As discussed during the METplus-Analysis project meeting on Nov 14, 2024, this is a rather low priority issue. The existing setup, with some duplication across the SonarQube workflows in the METplus repositories, works just fine. Recommend that we take the following approach... as long as the existing setup continues to work, just stick with it. If anything in the SonarQube workflows break, consider doing this work to fix it.