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.

Sign up for GitHub

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

Jump to bottom

feat(report): Use understandable value for shortDescription in SARIF reports #3009

Merged
merged 2 commits into from
Oct 20, 2022
Merged

feat(report): Use understandable value for shortDescription in SARIF reports #3009

merged 2 commits into from
Oct 20, 2022

Conversation

candrews
Copy link
Contributor

@candrews candrews commented Oct 11, 2022 •
edited by afdesk
Loading

Description

Use the vulnerability title as the value of shortDescription.

The shortDescription property SHOULD be a single sentence that is understandable when visible space is limited to a single line of text.

See: https://docs.oasis-open.org/sarif/sarif/v2.1.0/os/sarif-v2.1.0-os.html#_Toc34317845

Before:
image

After:
image

Related issues

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

@candrews candrews changed the title feat(reporting): Use understandable value for shortDescription in SARIF reports (#3008) feat(report): Use understandable value for shortDescription in SARIF reports (#3008) Oct 11, 2022
@candrews
feat(report): Use understandable value for shortDescription in SARIF …
046983a 
…reports (aquasecurity#3008)

Use the vulnerability title as the value of shortDescription.

> The shortDescription property SHOULD be a single sentence that is understandable when visible space is limited to a single line of text.

See: https://docs.oasis-open.org/sarif/sarif/v2.1.0/os/sarif-v2.1.0-os.html#_Toc34317845
Signed-off-by: Craig Andrews <candrews@integralblue.com>
@candrews
Copy link
Contributor Author

@afdesk can this be merged now?

If not, please let me know what I can do and I'll get right on it - thank you!

@knqyf263 knqyf263 requested a review from afdesk October 12, 2022 10:48
@afdesk
Copy link
Contributor

afdesk commented Oct 12, 2022

@candrews thanks again!
could you add samples before and after?
ex:
before:
изображение

after:
изображение

@candrews
Copy link
Contributor Author

Before:
image

After:
image

I think that's a nice improvement :)

@candrews
Copy link
Contributor Author

Can we now merge this one?

@afdesk
Copy link
Contributor

afdesk commented Oct 12, 2022 •
edited
Loading

Can we now merge this one?

@candrews
i think that yes, I've approved this PR.
your pictures were added into the description. I hope it's ok.

thanks a lot for your effort and patience.

@candrews
Copy link
Contributor Author

@knqyf263 and/or @afdesk - is now mergeable?

@candrews
Copy link
Contributor Author

@knqyf263 and/or @afdesk - bump 🤞 that this can be merged soon

@knqyf263 knqyf263 changed the title feat(report): Use understandable value for shortDescription in SARIF reports (#3008) feat(report): Use understandable value for shortDescription in SARIF reports Oct 20, 2022
@knqyf263 knqyf263 merged commit c1e24d5 into aquasecurity:main Oct 20, 2022
@knqyf263
Copy link
Collaborator

Thanks

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

@knqyf263 knqyf263 knqyf263 approved these changes

@afdesk afdesk afdesk approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve shortDescription in SARIF reports
3 participants
@candrews @afdesk @knqyf263