Skip to content

[Feature]: Generate Code Quality Report #83

Description

@Malcolmnixon

Problem Statement

The build pipeline should generate a "ReqStream Code Quality.pdf" file

Proposed Solution

Review other DemaConsulting projects such as https://github.com/demaconsulting/TestResults and:

  • Add DemaConsulting.SonarMark 1.0.0 and DemaConsulting.SarifMark 1.0.1 to the dotnet-tools.json file
  • Create a docs/quality folder with a code quality document template
  • Add a codeql job to the build.yaml file to scan the solution and upload the SARIF results artifact
  • Modify the build-docs job of build.yaml to:
    • Depend on the codeql job and download its SARIF artifact
    • Run the SarifMark tool to emit the docs/quality/codeql-quality.md then print it to console
    • Run the SonarMark tool to emit the docs/quality/sonar-quality.md then print it to console
    • Build the quality document to "docs/ReqStream Code Quality.pdf"
    • Remember to update the workflows that call build.yaml to have the appropriate permissions

Alternatives Considered

No response

Usage Examples

Benefits

Code Quality

Priority

Low - Nice to have

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

enhancementNew feature or request

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions