Class PublishOnCentralExtension
-
- All Implemented Interfaces:
public class PublishOnCentralExtensionThe extension in charge of configuring the publish-on-central plugin on the target project.
-
-
Field Summary
Fields Modifier and Type Field Description private final Property<Boolean>autoConfigureAllPublicationsprivate final RepositorymavenCentralprivate final Property<String>projectLongNameprivate final Property<Boolean>configureMavenCentralprivate final Property<String>projectDescriptionprivate final Property<String>licenseNameprivate final Property<String>licenseUrlprivate final Property<String>repoOwnerprivate final Property<String>scmConnectionprivate final Property<String>projectUrlprivate final Property<DocStyle>docStyleprivate final Projectproject
-
Constructor Summary
Constructors Constructor Description PublishOnCentralExtension(Project project)
-
Method Summary
Modifier and Type Method Description final Property<Boolean>getAutoConfigureAllPublications()Whether the plugin should consider all MavenPublications as potentially deliverable on Maven Central, and should thus configure them appropriately. final RepositorygetMavenCentral()Easier access to the default Maven Central configuration. final Property<String>getProjectLongName()The full project name. final Property<Boolean>getConfigureMavenCentral()A property, defaulting to true, that is used to disable the default configuration for Maven Central. final Property<String>getProjectDescription()A description of the project. final Property<String>getLicenseName()The project's license name. final Property<String>getLicenseUrl()The license URL connection of the project. final Property<String>getRepoOwner()For GitHub projects, the owner of the repo. final Property<String>getScmConnection()The SCM connection of the project. final Property<String>getProjectUrl()The URL of the project. final Property<DocStyle>getDocStyle()The style of javadocartifacts being published on Maven repositories.final ProjectgetProject()final Unitrepository(String url, String name, Function1<Repository, Unit> configurator)Utility to configure a new Maven repository as target. final Unitrepository(String url, String name)Utility to configure a new Maven repository as target. final Unitrepository(String url)Utility to configure a new Maven repository as target. final UnitmavenCentralSnapshotsRepository(String name, Function1<Repository, Unit> configurator)Utility to pre-configure a deployment towards the Maven Central Snapshots repository. final UnitmavenCentralSnapshotsRepository(String name)Utility to pre-configure a deployment towards the Maven Central Snapshots repository. final UnitmavenCentralSnapshotsRepository()Utility to pre-configure a deployment towards the Maven Central Snapshots repository. -
-
Method Detail
-
getAutoConfigureAllPublications
final Property<Boolean> getAutoConfigureAllPublications()
Whether the plugin should consider all MavenPublications as potentially deliverable on Maven Central, and should thus configure them appropriately. If disabled, the publications to be sent on Central must be configured manually by calling configurePomForMavenCentral on them in the buildscript.
-
getMavenCentral
final Repository getMavenCentral()
Easier access to the default Maven Central configuration.
-
getProjectLongName
final Property<String> getProjectLongName()
The full project name.
-
getConfigureMavenCentral
final Property<Boolean> getConfigureMavenCentral()
A property, defaulting to true, that is used to disable the default configuration for Maven Central. To be used in case of deployment towards only targets other than Maven Central.
-
getProjectDescription
final Property<String> getProjectDescription()
A description of the project.
-
getLicenseName
final Property<String> getLicenseName()
The project's license name.
-
getLicenseUrl
final Property<String> getLicenseUrl()
The license URL connection of the project.
-
getRepoOwner
final Property<String> getRepoOwner()
For GitHub projects, the owner of the repo. Used for the default values of projectUrl and scmConnection
-
getScmConnection
final Property<String> getScmConnection()
The SCM connection of the project.
-
getProjectUrl
final Property<String> getProjectUrl()
The URL of the project.
-
getDocStyle
final Property<DocStyle> getDocStyle()
The style of
javadocartifacts being published on Maven repositories.
-
getProject
final Project getProject()
-
repository
@JvmOverloads() final Unit repository(String url, String name, Function1<Repository, Unit> configurator)
Utility to configure a new Maven repository as target.
-
repository
@JvmOverloads() final Unit repository(String url, String name)
Utility to configure a new Maven repository as target.
-
repository
@JvmOverloads() final Unit repository(String url)
Utility to configure a new Maven repository as target.
-
mavenCentralSnapshotsRepository
@JvmOverloads() final Unit mavenCentralSnapshotsRepository(String name, Function1<Repository, Unit> configurator)
Utility to pre-configure a deployment towards the Maven Central Snapshots repository.
-
mavenCentralSnapshotsRepository
@JvmOverloads() final Unit mavenCentralSnapshotsRepository(String name)
Utility to pre-configure a deployment towards the Maven Central Snapshots repository.
-
mavenCentralSnapshotsRepository
@JvmOverloads() final Unit mavenCentralSnapshotsRepository()
Utility to pre-configure a deployment towards the Maven Central Snapshots repository.
-
-
-
-