Skip to content

Fix documentation for deprecated 'reports' object (Issue #5908) - #5924

Merged
BraisGabin merged 2 commits into
detekt:mainfrom
BeBAKE:fix-reports-docs-5908
Mar 26, 2023
Merged

BraisGabin merged 2 commits into
detekt:mainfrom
BeBAKE:fix-reports-docs-5908

Conversation

@BeBAKE

@BeBAKE BeBAKE commented Mar 21, 2023 •

Copy link
Copy Markdown
Contributor

I made a completely new branch and removed whitespaced and fixed the deprecated reports object.

Fixes #5908

@github-actions

github-actions Bot commented Mar 21, 2023 •

Copy link
Copy Markdown
Messages
📖

Thank you very much for making our website better ❤️!

Generated by 🚫 dangerJS against 36d44bd

Comment on lines 95 to 100
detekt {
reports.xml.required.set(true)
// reports.sarif.required.set(true)
reports {
xml.required.set(true)
// sarif.required.set(true)
}
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The docs are still wrong. The problem is that the whole:

detekt {
-   reports {
-        ...
-   }
}

is deprecated. Reports should be configured using this approach:
https://detekt.dev/docs/gettingstarted/gradle#reports

@cortinico cortinico left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM 👍

@codecov

codecov Bot commented Mar 25, 2023

Copy link
Copy Markdown

Codecov Report

Merging #5924 (36d44bd) into main (b07acae) will decrease coverage by 0.11%.
The diff coverage is 88.88%.

@@             Coverage Diff              @@
##               main    #5924      +/-   ##
============================================
- Coverage     84.56%   84.46%   -0.11%     
- Complexity     3782     3784       +2     
============================================
  Files           546      546              
  Lines         12933    12923      -10     
  Branches       2271     2268       -3     
============================================
- Hits          10937    10915      -22     
- Misses          863      877      +14     
+ Partials       1133     1131       -2     
Impacted Files Coverage Δ
...lab/arturbosch/detekt/formatting/FormattingRule.kt 90.56% <88.88%> (-1.50%) ⬇️

... and 2 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@BeBAKE

BeBAKE commented Mar 26, 2023

Copy link
Copy Markdown
Contributor Author

@BraisGabin BraisGabin added this to the 1.23.0 milestone Mar 26, 2023
@BraisGabin

Copy link
Copy Markdown
Member

That's not necessary. Thanks to improve the documentation

@BraisGabin
BraisGabin merged commit a722910 into detekt:main Mar 26, 2023
@BeBAKE
BeBAKE deleted the fix-reports-docs-5908 branch March 26, 2023 15:05

This branch was successfully deployed

1 active deployment
Preview — 36d44bd4 Deployed Mar 24, 2023 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation suggests using deprecated method

3 participants