Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add result markdown docs #21

Merged
merged 5 commits into from
Aug 19, 2024
Merged

Conversation

patrickpa
Copy link
Contributor

@patrickpa patrickpa commented Aug 12, 2024

Description

This PR adds a simple function to output the report markdown documentation.

The test output rendered as markdown:


Checker bundles

Checker bundle: TestBundle

  • Build date: 2024-05-31
  • Build version: 0.0.1
  • Description: Example checker bundle
  • Summary: Tested example checkers

Parameters:

  • None

Checkers:

Checker: TestChecker

  • Description: Test checker
  • Status:
  • Summary: Executed evaluation
  • Addressed rules:
    1. test.com:qc:1.0.0:qwerty.qwerty

Main changes

  1. Add write_markdown_docs to Result class
  2. Add tests to markdown docs function

How was the PR tested?

  1. Unit-tests for the desired output
  2. Tested with a few results loaded from checker bundles executions.

Notes

Signed-off-by: patrickpa <patrick@ivex.ai>
Signed-off-by: patrickpa <patrick@ivex.ai>
Signed-off-by: patrickpa <patrick@ivex.ai>
@patrickpa patrickpa self-assigned this Aug 12, 2024
Signed-off-by: patrickpa <patrick@ivex.ai>
Signed-off-by: patrickpa <patrick@ivex.ai>
Copy link
Contributor

@hoangtungdinh hoangtungdinh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @patrickpa

@hoangtungdinh hoangtungdinh merged commit 2223efb into develop Aug 19, 2024
7 checks passed
@hoangtungdinh hoangtungdinh deleted the patrick/add_result_md_docs branch August 19, 2024 09:09
hoangtungdinh pushed a commit that referenced this pull request Aug 21, 2024
Signed-off-by: patrickpa <patrick@ivex.ai>
hoangtungdinh pushed a commit that referenced this pull request Aug 21, 2024
Signed-off-by: Patrick Abrahão <patrick@ivex.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants