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 documentation for SARIF, severity and relative path #3433

Merged
merged 2 commits into from
Feb 1, 2021

Conversation

chao2zhang
Copy link
Member

This PR addresses item 3 in #3360.

This also enables SARIF report in the extension of the detekt repo itself.

@codecov
Copy link

codecov bot commented Feb 1, 2021

Codecov Report

Merging #3433 (6762016) into master (56b5f77) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #3433   +/-   ##
=========================================
  Coverage     80.37%   80.37%           
  Complexity     2777     2777           
=========================================
  Files           453      453           
  Lines          8377     8377           
  Branches       1605     1605           
=========================================
  Hits           6733     6733           
  Misses          775      775           
  Partials        869      869           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 56b5f77...6762016. Read the comment docs.

Copy link
Member

@schalkms schalkms left a comment

Choose a reason for hiding this comment

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

Hey! Thanks for improving the documentation part of detekt. I noticed that there’s redundant information. There’s already a section describing different output formats. We might want to merge them.

https://detekt.github.io/detekt/configurations.html#output-reports

@schalkms schalkms merged commit 84c0aa4 into detekt:master Feb 1, 2021
@cortinico cortinico added the housekeeping Marker for housekeeping tasks and refactorings label Feb 19, 2021
@cortinico cortinico added this to the 1.16.0 milestone Feb 19, 2021
@chao2zhang chao2zhang deleted the reporting branch April 18, 2021 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
housekeeping Marker for housekeeping tasks and refactorings
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants