Skip to content

Add GitHub action to run SonarQube for MET pull requests and feature branches #2379

@JohnHalleyGotway

Description

@JohnHalleyGotway

Describe the Enhancement

As of MET version 11.0.0, SonarQube is run nightly on an internal RAL/JNT project machine for MET, METplus, and the METplus Analysis tools. This was added via #2020 and the SonarQube version was updated via #2270. This task is to move that migrate that scanning from an internal nightly build up to GHA.

The workflow could be very similar to the existing testing.yml workflow. For a pull request, scan the code using SonarQube and compare it to a scan of the current reference branch. For example, compare to the PR scan to the current scan of the develop-ref branch.

Report success if the overall number of findings remain the same or decrease.
Report failure if the overall number of findings increase.

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 days of work.

Sub-Issues

Consider breaking the enhancement down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Needed for the Air Force - 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 PROJECT ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

The following SonarQube issues are closely related:

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

Metadata

Metadata

Type

No type

Projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions