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 Markdown Summary and Status Icons in Report #1047

Merged
merged 1 commit into from
Oct 3, 2023

Conversation

seanconroy2021
Copy link
Contributor

@seanconroy2021 seanconroy2021 commented Sep 28, 2023

  • Adds a new output,summary-markdown for generating Markdown summaries.
  • Implements the generateMarkdownSummary function to create Markdown summaries and status icon.

jira story: https://issues.redhat.com/browse/HACBS-2672

Blocked Until @simonbaird update success

notes:
need to be squashed and given better commit message

@codecov
Copy link

codecov bot commented Sep 28, 2023

Codecov Report

Merging #1047 (05e11b8) into main (b56e7c8) will increase coverage by 0.04%.
The diff coverage is 92.85%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1047      +/-   ##
==========================================
+ Coverage   85.07%   85.11%   +0.04%     
==========================================
  Files          66       66              
  Lines        5372     5400      +28     
==========================================
+ Hits         4570     4596      +26     
- Misses        802      804       +2     
Flag Coverage Δ
acceptance 68.39% <0.00%> (-0.39%) ⬇️
generative 4.50% <ø> (ø)
integration 66.44% <ø> (ø)
unit 71.21% <92.85%> (+0.12%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
internal/applicationsnapshot/report.go 86.91% <92.85%> (+1.02%) ⬆️

@seanconroy2021 seanconroy2021 added the help wanted Extra attention is needed label Sep 28, 2023
@seanconroy2021 seanconroy2021 changed the title [Hacbs 2672]Add Markdown Summary and Status Icons in Report Add Markdown Summary and Status Icons in Report Sep 28, 2023
zregvart

This comment was marked as resolved.

@seanconroy2021 seanconroy2021 force-pushed the HACBS-2672 branch 2 times, most recently from 563bd9d to 62ee5b3 Compare October 2, 2023 15:29
@seanconroy2021 seanconroy2021 removed the help wanted Extra attention is needed label Oct 2, 2023
@seanconroy2021 seanconroy2021 marked this pull request as ready for review October 2, 2023 16:40
Copy link
Member

@zregvart zregvart left a comment

Choose a reason for hiding this comment

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

LGTM, Squash and merge?

@seanconroy2021 seanconroy2021 force-pushed the HACBS-2672 branch 3 times, most recently from 9b6bda8 to 20ee120 Compare October 3, 2023 16:52
Copy link
Member

@simonbaird simonbaird left a comment

Choose a reason for hiding this comment

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

Lgtm.

}

writeMarkdownField(&markdownBuffer, "Time", r.created.UTC().Format("2006-01-02 15:04:05"), "")
writeMarkdownField(&markdownBuffer, "Name", " ", "")
Copy link
Member

Choose a reason for hiding this comment

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

What's the reason to have a "Name" row that's always empty? Should we just remove this row?

Implement generateMarkdownSummary() in report.go for Markdown CLI output
Add test cases for generateMarkdownSummary() in report_test.go
Introduce new output option summary-markdown for GitHub Action
Add status icon to Markdown summary
resolves: HACBS-2672
Signed-off-by: Sean Conroy [email protected]
@seanconroy2021 seanconroy2021 merged commit c6741e6 into enterprise-contract:main Oct 3, 2023
9 checks passed
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.

3 participants