Interface PublishingExtension
- Since:
- 1.3
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe name of this extension when installed by thePublishingPlugin("publishing"). -
Method Summary
Modifier and TypeMethodDescriptionThe publications of the project.The container of possible repositories to publish to.voidpublications(Action<? super PublicationContainer> configure) Configures the publications of this project.voidrepositories(Action<? super RepositoryHandler> configure) Configures the container of possible repositories to publish to.
-
Field Details
-
NAME
The name of this extension when installed by thePublishingPlugin("publishing").- See Also:
-
-
Method Details
-
getRepositories
RepositoryHandler getRepositories()The container of possible repositories to publish to.See
repositories(org.gradle.api.Action)for more information.- Returns:
- The container of possible repositories to publish to.
-
repositories
Configures the container of possible repositories to publish to.plugins { id 'publishing' } publishing { repositories { // Create an ivy publication destination named "releases" ivy { name = "releases" url = "http://my.org/ivy-repos/releases" } } }Therepositoriesblock is backed by aRepositoryHandler, which is the same DSL as that that is used for declaring repositories to consume dependencies from. However, certain types of repositories that can be created by the repository handler are not valid for publishing, such asRepositoryHandler.mavenCentral().At this time, only repositories created by the
ivy()factory method have any effect. Please seeIvyPublicationfor information on how this can be used for publishing to Ivy repositories.- Parameters:
configure- The action to configure the container of repositories with.
-
getPublications
PublicationContainer getPublications()The publications of the project.See
publications(org.gradle.api.Action)for more information.- Returns:
- The publications of this project.
-
publications
Configures the publications of this project.The publications container defines the outgoing publications of the project. That is, the consumable representations of things produced by building the project. An example of a publication would be an Ivy Module (i.e.
ivy.xmland artifacts), or Maven Project (i.e.pom.xmland artifacts).Actual publication implementations and the ability to create them are provided by different plugins. The "publishing" plugin itself does not provide any publication types. For example, given that the 'maven-publish' plugin provides a
MavenPublicationtype, you can create a publication like:plugins { id 'maven-publish' } publishing { publications { myPublicationName(MavenPublication) { // Configure the publication here } } }Please see
IvyPublicationandMavenPublicationfor more information on publishing in these specific formats.- Parameters:
configure- The action or closure to configure the publications with.
-