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

Improve documentation for Gradle repositories setup #3030

Merged
merged 3 commits into from
Sep 7, 2020

Conversation

BraisGabin
Copy link
Member

@BraisGabin BraisGabin commented Aug 28, 2020

Right now our gradle documentation is really verbose It repeats the same block of code 5 times so it's difficult to find what you are looking for.

I do think that jcenter is not the best repository and qw should be avoid it when possible. But that's the user choice and our documentation is not the place where we should promote that.

@codecov
Copy link

codecov bot commented Aug 28, 2020

Codecov Report

Merging #3030 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #3030   +/-   ##
=========================================
  Coverage     79.31%   79.31%           
  Complexity     2562     2562           
=========================================
  Files           432      432           
  Lines          7725     7725           
  Branches       1466     1466           
=========================================
  Hits           6127     6127           
  Misses          814      814           
  Partials        784      784           

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 c08de81...d15a1be. Read the comment docs.

@BraisGabin
Copy link
Member Author

We need to do something with codecov it's failing all the time.

content {
// just allow to include kotlinx projects
// detekt needs 'kotlinx-html' for the html report
includeGroup "org.jetbrains.kotlinx"
Copy link
Member

Choose a reason for hiding this comment

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

hm, I would really like to leave one of these for reference on.

Copy link
Member

Choose a reason for hiding this comment

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

Agree. Maybe we can refactor this into a ## Repositories section and have it listed only once?

Copy link
Member Author

Choose a reason for hiding this comment

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

I implemented the @cortinico suggestion. What do you think?

@arturbosch arturbosch merged commit 0a95547 into detekt:master Sep 7, 2020
@arturbosch arturbosch added this to the 1.13.0 milestone Sep 7, 2020
@arturbosch arturbosch changed the title Improve documentation Improve documentation for Gradle repositories setup Sep 7, 2020
@BraisGabin BraisGabin deleted the documentation branch September 8, 2020 08:19
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.

None yet

4 participants