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

Upgrade to new dokka #2931

Merged
merged 1 commit into from
Sep 7, 2020
Merged

Upgrade to new dokka #2931

merged 1 commit into from
Sep 7, 2020

Conversation

arturbosch
Copy link
Member

This checks if we finally can upgrade Gradle with the new dokka engine.
KtLint is not compatible with Kotlin 1.4-rc so I had to turn off detekt and formatting:test tasks

@BraisGabin
Copy link
Member

The regression in the Compiler and ktlint not working on kotlin 1.4 are known issues right? I mean, both projects have an issue to track it.

@arturbosch
Copy link
Member Author

The regression in the Compiler and ktlint not working on kotlin 1.4 are known issues right? I mean, both projects have an issue to track it.

Yes, KtLint tests against dev versions as of recently. The compiler bug is actually not a bug but a fix, the receiver is actually not needed anymore.

@arturbosch
Copy link
Member Author

Being unable to upgrade the Kotlin version and having to turn off analysis because of a dependency, rises the question if we should move the formatting module outside the main repo again ...

@arturbosch
Copy link
Member Author

 * What went wrong:
    An exception occurred applying plugin request [id: 'org.jetbrains.kotlin.jvm']
    > Failed to apply plugin [id 'org.jetbrains.kotlin.jvm']
       > The current Gradle version 5.0 is not compatible with the Kotlin Gradle plugin. Please use Gradle 5.3 or newer, or the previous version of the Kotlin plugin.

We need to update to 5.3 too.

@codecov
Copy link

codecov bot commented Aug 17, 2020

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #2931   +/-   ##
=========================================
  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...4ca3931. Read the comment docs.

binkley pushed a commit to binkley/kotlin-dice that referenced this pull request Aug 17, 2020
NB -- disables ktlint until 1.4 support.
See detekt/detekt#2931
@arturbosch
Copy link
Member Author

dokka changes its sorting for

interface Context {
val findings: List<Finding>
/**
* Reports a single new violation.
*/
@Deprecated("Overloaded version with extra ruleSetId parameter should be used.")
fun report(finding: Finding, aliases: Set<String> = emptySet())
/**
* Reports a single new violation.
* By contract the implementation can check if
* this finding is already suppressed and should not get reported.
* An alias set can be given to additionally check if an alias was used when suppressing.
* Additionally suppression by rule set id is supported.
*/
fun report(finding: Finding, aliases: Set<String> = emptySet(), ruleSetId: RuleSetId? = null) {
report(finding, aliases, null)
}
/**
* Same as [report] but reports a list of findings.
*/
@Deprecated("Overloaded version with extra ruleSetId parameter should be used.")
fun report(findings: List<Finding>, aliases: Set<String> = emptySet())
/**
* Same as [report] but reports a list of findings.
*/
fun report(findings: List<Finding>, aliases: Set<String> = emptySet(), ruleSetId: RuleSetId? = null) {
report(findings, aliases, null)
}

so our verifyDocumentation will always fail.

I've opened Kotlin/dokka#1333 which is a major blocker for using the new dokka and therefore updating Gradle ...

@@ -29,9 +29,9 @@ object MultiVersionTest : Spek({

private fun getGradleVersionsUnderTest() =
if (getJdkVersion() < 13) {
listOf("5.0", "6.4.1")
listOf("5.3", "6.6")
Copy link
Member

Choose a reason for hiding this comment

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

We should update our documentation too, right pointing the minimum version.

@arturbosch arturbosch added migration Marker to add a migration step in the changelog and removed migration Marker to add a migration step in the changelog labels Aug 18, 2020
@arturbosch arturbosch changed the title Support Kotlin 1.4, new dokka and Gradle 6.6 Upgrade to new dokka Aug 18, 2020
@arturbosch
Copy link
Member Author

I've extracted the Kotlin and Gradle upgrade to #2981.
This PR needs to wait until a stable dokka gets released.

@BraisGabin BraisGabin mentioned this pull request Aug 18, 2020
@arturbosch arturbosch added housekeeping Marker for housekeeping tasks and refactorings and removed blocked labels Sep 3, 2020
@arturbosch arturbosch added this to the 1.13.0 milestone Sep 3, 2020
@arturbosch arturbosch marked this pull request as ready for review September 3, 2020 20:43
@arturbosch
Copy link
Member Author

New version fixed our problem. Huge diff but works as expected.

@arturbosch arturbosch merged commit aad1501 into master Sep 7, 2020
@arturbosch arturbosch deleted the try-dokka-1.4 branch September 7, 2020 19:33
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.

None yet

3 participants