Gradle 插件本地化及发布实践：uploadArchives、maven-publish 入门指南
2023-11-23 10:24:40
前言
在 Gradle 插件开发过程中，我们需要将插件发布到远程仓库，以便其他开发者可以方便地引用和使用。Gradle 提供了两种发布插件的官方方式：
- 使用
uploadArchives任务将插件发布到本地仓库。 - 使用
maven-publish插件将插件发布到远程仓库，如 Maven Central。
本文将介绍如何使用这两种方式发布 Gradle 插件，并提供示例脚本供您参考。
本地化发布
本地化发布是指将插件发布到本地仓库。这通常用于在团队内部共享插件，或者在发布到远程仓库之前对插件进行测试。
使用 uploadArchives 任务
要使用 uploadArchives 任务发布插件，您需要在插件的 build.gradle 文件中添加以下代码：
task uploadArchives(type: Upload) {
repositories {
mavenLocal()
}
}
这将创建一个名为 uploadArchives 的任务，该任务会将插件的 JAR 文件上传到本地 Maven 仓库。
您可以通过运行以下命令来执行此任务：
./gradlew uploadArchives
执行此命令后，您可以在本地 Maven 仓库中找到插件的 JAR 文件。
远程发布
远程发布是指将插件发布到远程仓库，如 Maven Central。这允许其他开发者通过 Maven 依赖管理系统来引用和使用您的插件。
使用 maven-publish 插件
要使用 maven-publish 插件发布插件，您需要在插件的 build.gradle 文件中添加以下代码：
plugins {
id 'maven-publish'
}
publishing {
publications {
maven(MavenPublication) {
groupId 'com.example'
artifactId 'my-plugin'
version '1.0.0'
from components.java
}
}
repositories {
maven {
url 'https://maven.pkg.github.com/username/reponame'
credentials {
username = project.findProperty('gpr.user') ?: System.getenv('GPR_USER')
password = project.findProperty('gpr.key') ?: System.getenv('GPR_API_KEY')
}
}
}
}
这将创建一个名为 maven 的发布配置，该配置指定了插件的组 ID、工件 ID、版本号以及要发布的组件。
您可以通过运行以下命令来发布插件：
./gradlew publish
执行此命令后，您的插件将被发布到远程仓库。
示例脚本
以下是使用 uploadArchives 和 maven-publish 插件发布 Gradle 插件的示例脚本：
uploadArchives 使用示例
./gradlew clean build uploadArchives
maven-publish 使用示例
./gradlew clean build publish
常见问题解答
我应该使用 uploadArchives 还是 maven-publish？
如果您只是想在团队内部共享插件，或者在发布到远程仓库之前对插件进行测试，那么您可以使用 uploadArchives 任务。
如果您想将插件发布到远程仓库，以便其他开发者可以引用和使用，那么您需要使用 maven-publish 插件。
我需要做什么才能将插件发布到 Maven Central？
要将插件发布到 Maven Central，您需要先创建一个 GitHub 账号和一个 Maven Central 账号。然后，您需要将插件的源代码和文档上传到 GitHub，并向 Maven Central 提交一个发布请求。
有关如何将插件发布到 Maven Central 的详细说明，请参考 Maven Central 的官方文档：https://central.sonatype.org/publish/publish-guidelines/
我在发布插件时遇到了问题，该怎么办？
如果您在发布插件时遇到问题，您可以参考 Gradle 的官方文档：https://docs.gradle.org/current/userguide/publishing_plugins.html
您还可以到 Gradle 社区论坛寻求帮助：https://discuss.gradle.org/
总结
本文介绍了如何使用 uploadArchives 任务和 maven-publish 插件发布 Gradle 插件。希望对您有所帮助。
