Gradle Sonatype Nexus 插件使用文档

1. 安装指南

项目依赖

在构建脚本中添加以下依赖以引入 Gradle Sonatype Nexus 插件：

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'com.bmuschko:gradle-nexus-plugin:2.3.1'
    }
}

插件应用

在构建脚本中应用插件：

apply plugin: 'com.bmuschko.nexus'

2. 项目的使用说明

默认任务

Nexus 插件会向项目中添加以下任务：

• javadocJar：创建包含项目生成的 Javadoc API 文档的 JAR 归档（默认添加）。
• sourcesJar：创建包含项目主要源代码的 JAR 归档（默认添加）。
• testsJar：创建包含项目测试源代码的 JAR 归档。

所有任务的输出都会添加到 archives 配置中。

扩展属性

插件在 extraArchive 和 nexus 闭包中定义了以下扩展属性：

• javadoc：向项目添加 Javadoc JAR 任务（默认为 true）。

• sources：向项目添加源代码 JAR 任务（默认为 true）。

• tests：向项目添加测试源代码 JAR 任务（默认为 false）。

• sign：指定是否使用签名插件对 artifacts 进行签名（默认为 true）。

• configuration：用于发布 artifacts 的自定义配置（默认为 archives）。

• repositoryUrl：稳定版本仓库 URL（默认为 https://oss.sonatype.org/service/local/staging/deploy/maven2/）。

• snapshotRepositoryUrl：快照仓库 URL（默认为 https://oss.sonatype.org/content/repositories/snapshots/）。

POM 定制

可以通过 modifyPom 闭包修改自动生成的 POM 文件。

modifyPom {
    project {
        ...
    }
}

凭证

在 ~/.gradle/gradle.properties 文件中设置上传 artifacts 所需的 Nexus 凭证。

nexusUsername = yourUsername
nexusPassword = yourPassword

如果不指定这些属性，插件将在控制台中提示输入它们的值。

示例配置

modifyPom {
    project {
        name 'Gradle Sonatype Nexus 插件'
        description '为 Gradle 提供配置和上传 artifacts 到 Sonatype Nexus 的任务'
        url 'https://github.com/bmuschko/gradle-nexus-plugin'
        inceptionYear '2012'

        scm {
            url 'https://github.com/bmuschko/gradle-nexus-plugin'
            connection 'scm:https://[e-mail]/bmuschko/gradle-nexus-plugin.git'
            developerConnection 'scm:git://github.com/bmuschko/gradle-nexus-plugin.git'
        }

        licenses {
            license {
                name 'Apache 软件许可，版本 2.0'
                url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                distribution 'repo'
            }
        }

        developers {
            developer {
                id 'bmuschko'
                name 'Benjamin Muschko'
                email '[e-mail]'
            }
        }
    }
}

extraArchive {
    sources = false
    tests = true
    javadoc = false
}

nexus {
    sign = true
    repositoryUrl = 'http://localhost:8081/nexus/content/repositories/internal/'
    snapshotRepositoryUrl = 'http://localhost:8081/nexus/content/repositories/internal-snapshots/'
}

3. 项目 API 使用文档

请参考项目 GitHub 仓库的 Wiki 页面获取详细的 API 使用文档。

4. 项目安装方式

由于该项目已达到生命周期结束（EOL）状态，与 Gradle 7.0 不兼容，因此无法提供安装方式。如果您的项目使用的是早期版本的 Gradle，可以按照上述的安装指南进行操作。