librarian-gradle-plugin/com.gradleup.librarian.gradle

Package-level declarations

Types

Bcv

class Bcv(val warnIfMissing: Boolean, val excludePatterns: List<String>)

Coordinates

class Coordinates(val groupId: String, val artifactId: String, val version: String)

Gcs

class Gcs(val serviceAccountJson: () -> String?, val bucket: String, val prefix: String)

GeneratePluginVersion

abstract class GeneratePluginVersion : DefaultTask

Kdoc

class Kdoc(val projects: List<String>, val olderVersions: List<Coordinates>)

Librarian

class Librarian

Plugin

abstract class Plugin : Plugin<Project>

PomMetadata

class PomMetadata(val artifactId: String?, val description: String, val vcsUrl: String, val developer: String, val license: String)

User metadata for .pom or .module metadata associated with the repository. This metadata is the same in all modules

Publishing

class Publishing(val createMissingPublications: Boolean, val publishPlatformArtifactsInRootModule: Boolean, val pomMetadata: PomMetadata, val emptyJarLink: String?)

Signing

class Signing(val privateKey: String?, val privateKeyPassword: String?)

Sonatype

class Sonatype(val username: String?, val password: String?, val publishingType: String?, val validationTimeout: Duration?, val publishingTimeout: Duration?)

Properties

kotlinExtension

val Project.kotlinExtension: KotlinProjectExtension

Functions

allAppleTargets

fun KotlinMultiplatformExtension.allAppleTargets()

configureAndroidCompatibility

fun Project.configureAndroidCompatibility(minSdk: Int, compileSdk: Int, testTargetSdk: Int)

configureBcv

fun Project.configureBcv(warnIfMissing: Boolean = true, excludePatterns: List<String> = emptyList())

configureDokka

fun Project.configureDokka()

configureDokkaAggregate

fun Project.configureDokkaAggregate(currentVersion: String, olderVersions: List<Coordinates>, aggregateConfiguration: String, projectPaths: List<String>): TaskProvider<Jar>

configureGeneratedVersion

fun Project.configureGeneratedVersion(packageName: String, pomVersion: String)

configurePom

fun Project.configurePom(pomMetadata: PomMetadata)

Configures pom

configurePublishing

fun Project.configurePublishing(group: String, version: String, createMissingPublications: Boolean, publishPlatformArtifactsInRootModule: Boolean, pomMetadata: PomMetadata, signing: Signing?, emptyJarLink: String?)

configureSigning

fun Project.configureSigning(signing: Signing)

Coordinates

fun Coordinates(coordinates: String): Coordinates

createMissingPublications

fun Project.createMissingPublications(docUrl: String? = null)

Creates missing publications based on the plugins being applied and the tasks found in the project.

Gcs

fun Gcs(properties: Properties): Gcs?

librarianModule

fun Project.~~librarianModule~~()

fun Project.librarianModule(group: String, version: String, jvmTarget: Int?, kotlinTarget: String?, checkDependencies: Boolean, bcv: Bcv?, versionPackageName: String?, publishing: Publishing?, signing: Signing?)

librarianRoot

fun Project.~~librarianRoot~~()

fun Project.librarianRoot(group: String, version: String, publishing: Publishing, signing: Signing, sonatype: Sonatype, gcs: Gcs?, kdoc: Kdoc)

plugin

fun plugin(project: Project)

Unused plugin, only serves as a convenience to pull the librarian jar into the build classpath

PomMetadata

fun PomMetadata(artifactId: String?, properties: Properties): PomMetadata