Chapter 36. Maven Publishing (new)(译文)

原文地址:https://docs.gradle.org/4.1/userguide/publishing_maven.html#sec:the_mavenpublish_plugin
为学习gradle上传中使用maven上传aar jar artifact至maven仓库(私服or mavenCentral)
ps:从一个程序员的角度翻译,应该更能让大家易于接受

目录

  • [36.1. The “maven-publish” Plugin] maven-publish插件介绍
  • [36.2. Publications]发版物
  • [36.3. Repositories]仓库
  • [36.4. Performing a publish]执行发布
  • [36.5. Publishing to Maven Local]发布到本地Maven仓库
  • [36.6. Generating the POM file without publishing]生成POM文件不依赖发版

本章介绍由“maven-publish”插件提供的新的Maven发布支持。 最终,这种新的出版支持将通过上传任务取代发布任务(及 maven_push 将取代 uploadArchives 任务)。

注意:此插件生成的生成的POM文件目前不受支持。 Gradle的未来版本可能会添加此功能。 请使用 Maven plugin 将您的工件发布到Maven Central。

如果您正在使用上传任务查找原始Maven发布支持的文档(上传至mavenCentral),请参阅Chapter 32, Publishing artifacts.。

36.1. The “maven-publish” Plugin(maven_publish插件介绍)

以Maven格式发布的能力由“maven-publish”插件提供。

“publishing”插件在名为 “publishing” 的 PublishingExtension类型的项目上创建了一个extension.此extension提供了一个命名发布的容器和一个命名仓库的容器。

“maven-publish”插件适用于 MavenPublication出版物和 MavenArtifactRepository存储库。

Example 36.1. Applying the ‘maven-publish’ plugin

build.gradle

apply plugin: 'maven-publish'
36.2. Publications(出版物介绍)

如果您不熟悉项目artifacts和配置,则应阅读 Chapter 32, Publishing artifacts这里介绍了基本的概念。 本章还介绍了使用不同于本章所述机制的“publishing artifacts”。 这里描述的发布功能最终将取代该功能。

对于“maven-publish”插件有任何影响,必须将MavenPublication 添加到该组发布中。 此出版物确定实际发布的artifacts以及相关POM文件中包含的详细信息。 可以通过添加组件,自定义工件以及直接修改生成的POM文件来配置发布。

36.2.1. Publishing a Software Component(发布软件组件)

将Gradle项目发布到Maven存储库的最简单的方法是指定要发布的SoftwareComponent。 目前可供出版的组件有:

《Chapter 36. Maven Publishing (new)(译文)》

在以下示例中,工件和运行时依赖关系取自Java插件添加的“java”组件。
Example 36.2. Adding a MavenPublication for a Java component

build.gradle

publishing {
    publications {
        mavenJava(MavenPublication) {
            from components.java
        }
    }
}
36.2.2. Publishing custom artifacts(上传自定义artifacts)

也可以显式地配置要包含在发布中的artifacts。 Artifacts通常作为原始文件提供,或作为AbstractArchiveTask (e.g. Jar, Zip)的实例提供。

对于每个自定义artifact,可以指定要用于发布的extension和classifier。 请注意,只有一个已发布的工件可以具有classifier,并且所有其他artifacts必须具有唯一的classifier/extension组合。

配置自定义artifacts如下:
Example 36.3. Adding additional artifact to a MavenPublication

build.gradle

task sourceJar(type: Jar) {
    from sourceSets.main.allJava
}

publishing {
    publications {
        mavenJava(MavenPublication) {
            from components.java

            artifact sourceJar {
                classifier "sources"
            }
        }
    }
}

有关如何自定义artifacts的更多信息,请参阅API文档中的MavenPublication 类。

36.2.3. Identity values in the generated POM(POM文件生成及配置)

生成的POM文件的属性将包含从以下项目属性派生的标识值:

覆盖默认标识值很简单:在配置MavenPublication时,只需指定groupId,artifactId或版本属性即可。
Example 36.4. customizing the publication identity

build.gradle

publishing {
    publications {
        maven(MavenPublication) {
            groupId 'org.gradle.sample'
            artifactId 'project1-sample'
            version '1.1'

            from components.java
        }
    }
}

Maven将“groupId”和“artifactId”限制为有限的字符集([A-Za-z0-9 _ \ – 。] +)),并且Gradle强制执行此限制。 对于’version’(以及artifact’extension’和’classifier’),Gradle将处理任何有效的Unicode字符。

明确禁止的唯一Unicode值是“\”,“/”和任何ISO控制字符。 提供的价值在出版初期得到验证。

注意:某些存储库将无法处理所有支持的字符。 例如,当在Windows上发布到文件系统支持的存储库时,’:’字符不能用作标识符。

36.2.4. Modifying the generated POM(修改生成的POM)

生成的POM文件可能需要在发布之前进行调整。 “maven-publish”插件提供了一个钩子来允许这样的修改。
Example 36.5. Modifying the POM file

build.gradle

publications {
    mavenCustom(MavenPublication) {
        pom.withXml {
            asNode().appendNode('description',
                                'A demonstration of maven POM customization')
        }
    }
}

在这个例子中,我们为生成的POM添加了一个’description’元素。 使用此钩子,您可以修改POM的任何方面。 例如,您可以将依赖关系的版本范围替换为用于生成构建的实际版本。

有关更多信息,请参阅API文档中的MavenPom.withXml(org.gradle.api.Action)

实际上可以修改所创建的POM的任何方面。 这意味着也可以修改POM,使其不再是有效的Maven POM,因此在使用此功能时必须小心。

发布模块的标识符(groupId,artifactId,version)是一个例外; 这些值不能在POM中使用withXML钩子修改。

36.2.5. Publishing multiple modules(发布多个模块)

有时,您可以从Gradle构建中发布多个模块,而无需创建单独的Gradle子项目。 一个例子是为您的库发布单独的API和实现jar。 使用Gradle这很简单:
Example 36.6. Publishing multiple modules from a single project

build.gradle

task apiJar(type: Jar) {
    baseName "publishing-api"
    from sourceSets.main.output
    exclude '**/impl/**'
}

publishing {
    publications {
        impl(MavenPublication) {
            groupId 'org.gradle.sample.impl'
            artifactId 'project2-impl'
            version '2.3'

            from components.java
        }
        api(MavenPublication) {
            groupId 'org.gradle.sample'
            artifactId 'project2-api'
            version '2'

            artifact apiJar
        }
    }
}

如果一个项目定义了多个出版物,那么Gradle将会将这些发布到定义的存储库中。 每个出版物必须具有如上所述的唯一身份。

36.3. Repositories(仓库)

出版物被发布到仓库。 发布到的存储库由 PublishingExtension.getRepositories()容器定义。
Example 36.7. Declaring repositories to publish to

build.gradle

publishing {
    repositories {
        maven {
            // change to point to your repo, e.g. http://my.org/repo
            url "$buildDir/repo"
        }
    }
}

用于声明存储库以进行发布的DSL是用于声明存储库以从 RepositoryHandler使用依赖关系的DSL。 但是,在Maven发布的上下文中,只能使用 MavenArtifactRepository存储库进行发布。

36.4. Performing a publish(执行发布)

“maven-publish”插件会自动为publisher.publications和publishing.repositories容器中的每个MavenPublication和MavenArtifactRepository组合创建一个PublishToMavenRepository任务。

创建的任务名为“发布”publish«PUBNAME»PublicationTo«REPONAME»Repository“。

Example 36.8. Publishing a project to a Maven repository

build.gradle

apply plugin: 'java'
apply plugin: 'maven-publish'

group = 'org.gradle.sample'
version = '1.0'

publishing {
    publications {
        mavenJava(MavenPublication) {
            from components.java
        }
    }
}
publishing {
    repositories {
        maven {
            // change to point to your repo, e.g. http://my.org/repo
            url "$buildDir/repo"
        }
    }
}

Output of gradle publish

> gradle publish
:generatePomFileForMavenJavaPublication
:compileJava
:processResources NO-SOURCE
:classes
:jar
:publishMavenJavaPublicationToMavenRepository
:publish

BUILD SUCCESSFUL in 0s
4 actionable tasks: 4 executed

在此示例中,创建名为“publishMavenJavaPublicationToMavenRepository”的任务,其类型为PublishToMavenRepository。 此任务已连接到发布生命周期任务。 执行“gradle publish”构建POM文件和要发布的所有工件,并将它们传输到存储库。

36.5. Publishing to Maven Local发布到本地maven仓库)

为了与本地Maven安装进行集成,有时将模块发布到本地.m2存储库中是有用的。 在Maven的说法中,这被称为“安装”模块。 “maven-publish”插件通过在publishing.publications容器中为每个 MavenPublication自动创建一个 PublishToMavenLocal任务来实现这一点。 每个这些任务都连接到publishToMavenLocal生命周期任务中。 你的publishing.repositories部分不需要mavenLocal

创建的任务名为“publish«PUBNAME»PublicationToMavenLocal“。

Example 36.9. Publish a project to the Maven local repository

Output of gradle publishToMavenLocal

> gradle publishToMavenLocal
:generatePomFileForMavenJavaPublication
:compileJava
:processResources NO-SOURCE
:classes
:jar
:publishMavenJavaPublicationToMavenLocal
:publishToMavenLocal

BUILD SUCCESSFUL in 0s
4 actionable tasks: 4 executed

此示例中生成的任务名为“publishMavenJavaPublicationToMavenLocal”。 此任务已连接到publishToMavenLocal生命周期任务中。 执行“gradle publishToMavenLocal”构建POM文件和要发布的所有工件,并将它们“安装”到本地Maven存储库中。

36.6. Generating the POM file without publishing

有时在实际发布时为模块生成Maven POM文件是有用的。 由于POM生成由单独的任务执行,因此很容易实现。

生成POM文件的任务是GenerateMavenPom类型,并且根据发布的名称给出一个名称:“generatePomFileFor«PUBNAME»Publication“。 所以在下面的例子中,出版物名为“mavenCustom”,任务将被命名为“generatePomFileForMavenCustomPublication”。

Example 36.10. Generate a POM file without publishing

build.gradle

model {
    tasks.generatePomFileForMavenCustomPublication {
        destination = file("$buildDir/generated-pom.xml")
    }
}

Output of gradle generatePomFileForMavenCustomPublication

> gradle generatePomFileForMavenCustomPublication
:generatePomFileForMavenCustomPublication

BUILD SUCCESSFUL in 0s
1 actionable task: 1 executed

发布模型的所有细节仍然在POM生成中考虑,包括组件,自定义工件以及通过pom.withXml进行的任何修改。

“maven-publish”插件利用了后期插件配置的一些实验支持,任何GenerateMavenPom任务将不会被构建,直到配置发布扩展。 当您尝试访问GenerateMavenPom任务时,确保发布插件配置的最简单的方法是将访问放置在模型块中,如上所述。
同样适用于任何尝试访问特定于发布的任务,如PublishToMavenRepository.。 这些任务应该在模型块内引用。

内容如有错误仅供参考,后续给出使用实例

    原文作者:SYfarming
    原文地址: https://www.jianshu.com/p/bf5c0a50ed87
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞