Skip to content

[Feature]: Add CodeQL analysis results to Code Quality report #82

@Malcolmnixon

Description

@Malcolmnixon

Problem Statement

The Code Quality report should include CodeQL analysis results.

Proposed Solution

Examine the https://github.com/demaconsulting/SonarMark project and review how it's added CodeQL analysis, then apply the appropriate changes to this project. The changes include:

  • Ensure the codeql job in the build.yaml matches the other projects - including having a codeql-config.yml file and saving the SARIF results as artifacts
  • Add DemaConsulting.SarifMark 1.0.1 to the dotnet-tools.json
  • Modify the build-docs job to depend on the codeql job, download the SARIF artifact, run SarifMark and emit the docs/quality/codeql-quality.md file
  • Modify the Code Quality Report pandoc definition to include the docs/quality/codeql-quality.md file
  • Delete the old build_docs.yaml file - it should now be embedded in the build.yaml file
  • Check for any other updates relevant to the CodeQL to Code Quality document path.

Alternatives Considered

No response

Usage Examples

Benefits

Code Quality reports.

Priority

Medium - Would improve my workflow

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

No response

Checklist

  • I have searched existing issues to ensure this is not a duplicate
  • I have provided a clear description of the feature
  • I have explained why this feature would be useful

Metadata

Metadata

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions