v1.2.0

What's Changed

• fix snapshot publish workflow by @aSemy in #53
• Fix Kotlin Adapter for Kotlin Multiplatform projects by @aSemy in #52
• bump Kotest and BCV-MU by @aSemy in #56

Full Changelog: v1.1.1...v1.2.0

v1.1.1

This release contains some deprecations, and some minor fixes.

What's Changed

• fix adding compile-time Kotlin dependencies to Dokka Source Set #45
• Enable externalDocumentationLinks by default #46
• fix appending package-list to external doc links #47
• tidy up external doc links helpers #48

Full Changelog: v1.1.0...v1.1.1

v1.1.0

What's Changed

Full Changelog: v1.0.0...v1.1.0

Find the latest plugins on the Gradle Plugin Portal

⚠ This release contains breaking changes. There is no migration support in the form of @Deprecated annotations. If you would like some help migrating please make an issue or discussion.

⚠ Breaking change | ✂ Minimize exposure of Dokka Core types to plugin users #39

The last release attempted to remove Dokka from the public API, so that Dokkatoo would not need a compile-time on Dokka. A few Dokka classes were missed though, so they have been fixed in this release.

• Replace Dokka Core Platform with enum, KotlinPlatform (impacts DokkaSourceSetSpec.analysisPlatform)
• Replace DokkaCore class DokkaSourceSetID with DokkaSourceSetIdSpec (impacts DokkaSourceSetSpec.sourceSetID and DokkaSourceSetSpec.dependentSourceSets)

Other changes

• commit IJ code style by @aSemy in #40
• remove KxS BCV exclusion, and unmark some companion objects as internal by @aSemy in #41
• Tidy buildSrc utils by @aSemy in #42
• expose the @DokkatooInternalApi opt-in annotation as public (otherwise no one can opt-in!) 3303c9d
• Update the KDoc for custom assets, to highlight handling relative paths 83d26f3
• Update Dokkatoo's Dokka docs to add a source-code link 62f19ec

Deprecations

• DokkatooPrepareParametersTask.outputDir didn't do anything.

  The output directory should instead be set using dev.adamko.dokkatoo.DokkatooExtension.dokkatooPublicationDirectory (or dev.adamko.dokkatoo.DokkatooExtension.dokkatooModuleDirectory for modules)

Breaking changes

Continuing on from the last release

v1.0.0

What's Changed

Full Changelog: v0.0.4...v1.0.0

Find the latest plugins on the Gradle Plugin Portal

⚠ This release contains breaking changes. There is no migration support in the form of @Deprecated annotations. If you would like some help migrating please make an issue or discussion.

📚 Use Dokkatoo to document Dokkatoo #32

The Dokkatoo API is now documented using... Dokkatoo! Check it out: https://adamko-dev.github.io/dokkatoo/

📢 Reduce logging noise #34

Debug logging has been reduced. Dokkatoo is now quieter. A few warnings have also been fixed.

⚠ Breaking change | ✂ remove Dokka code from public API, replace with equivalents #35

Dokkatoo no longer has a public dependency on Dokka. This makes development of Dokkatoo more flexible, and simplifies usage. It does, however, include a breaking change.

If you manually set the documented visibility please replace any usage of org.jetbrains.dokka.DokkaConfiguration.Visibility with dev.adamko.dokkatoo.dokka.parameters.VisibilityModifier

// import org.jetbrains.dokka.DokkaConfiguration.Visibility
import dev.adamko.dokkatoo.dokka.parameters.VisibilityModifier // replacement

dokkatoo {
  dokkatooSourceSets.create("MyCustomSourceSet") {
    //documentedVisibilities(Visibility.INTERNAL) // old
    documentedVisibilities(VisibilityModifier.INTERNAL) // replacement
    // ...
  }
}

ℹ️ If you have depended on Dokkatoo via its Maven coordinates, you probably also had to depend on Dokka Core. This should no longer be necessary:

// ./buildSrc/build.gradle.kts

dependencies {
  implementation("dev.adamko.dokkatoo:dokkatoo-plugin:1.0.0")
  // implementation("org.jetbrains.dokka:dokka-core:1.8.10") ⬅ no longer necessary
}

⚠ Breaking change | 🎢 Improve Dokka plugin parameters DSL #36

Configuration for Dokka Plugins has been refactored.

• The API is now more convenient (no more manual JSON configuration),
• the XML format option was removed
• parameters are compatible with Gradle up-to-date checks (properties are correctly annotated with Gradle input annotations).

Example migration:

// build.gradle.kts

dokkatoo {
  dokkatooPublications.configureEach {
    pluginsConfiguration.create("org.jetbrains.dokka.base.DokkaBase") {
      serializationFormat.set(DokkaPluginConfigurationSpec.EncodedFormat.JSON)
      values.set(
        """
          { 
            "customStyleSheets": [
              "${file("./customResources/logo-styles.css").invariantSeparatorsPath}", 
              "${file("./customResources/custom-style-to-add.css").invariantSeparatorsPath}"
            ], 
            "customAssets": [
              "${file("./customResources/custom-resource.svg").invariantSeparatorsPath}"
            ] 
          }
        """.trimIndent()
      )
    }
  }
}

Should be replaced with:

// build.gradle.kts
import dev.adamko.dokkatoo.dokka.plugins.DokkaHtmlPluginParameters

dokkatoo {

  pluginsConfiguration.named<DokkaHtmlPluginParameters>("html") {
    customStyleSheets.from(
      "./customResources/logo-styles.css",
      "./customResources/custom-style-to-add.css",
    )
    customAssets.from(
      "./customResources/custom-resource.svg",
    )
  }
}

v0.0.4

What's Changed

• Simplify release versioning by @aSemy in #28
• remove Dokka migration code by @aSemy in #29
• Gradle version catalog by @aSemy in #30
• update to Dokka 1.8 by @aSemy in #31

Full Changelog: v0.0.3...v0.0.4

v0.0.3

What's Changed

• refactor configuration & task names to be specific to each DokkatooFormatPlugin by @aSemy in #19
• Fix it-basic Dokkatoo plugin version by @aSemy in #22
• add social preview banner (used in GitHub Social Preview) by @aSemy in #23
• add util for clearing GH Action caches by @aSemy in #20
• fix multi-project up-to-date checks by @aSemy in #24
• Add binary-compatibility-validator by @aSemy in #25
• Improve test performance by @aSemy in #26
• create additional test for multi-module file updates by @aSemy in #27

Full Changelog: v0.0.2...v0.0.3

v0.0.2

What's Changed

• update docs by @aSemy in #8
• Refactor builder classes by @aSemy in #9
• log DokkaGenerator to file, not stdout by @aSemy in #13
• Fix JDK package list URL by @aSemy in #15
• Update custom format example by @aSemy in #16
• tidy/de-dupe build test code & descriptions by @aSemy in #17
• Fix configuration cache by @aSemy in #18

Full Changelog: v0.0.1...v0.0.2

v0.0.1

Initial release!

Gradle Plugin Portal publication is pending https://plugins.gradle.org/search?term=dokkatoo