GitHub Release Gradle 插件使用指南

GitHub Release Gradle 插件使用指南

---

项目介绍

GitHub Release Gradle插件 是一个用于通过Gradle构建过程向GitHub推送版本发布的工具。它利用OkHttp库向GitHub API发送POST请求，从而创建发布并上传指定的资产文件。此插件未得到GitHub官方背书，但为开发者提供了一种自动化管理GitHub仓库中发布版本的便捷方式。它支持自定义发布名称、身体内容、上传特定资产，并处理草稿与预发布版本等复杂场景。

项目快速启动

要快速开始使用此插件，首先确保你的项目已配置好Gradle环境。然后，依据以下步骤集成插件：

添加依赖

使用Plugins DSL（推荐）

在build.gradle或build.gradle.kts(对于Kotlin DSL)文件顶部添加以下内容:

plugins {
    id 'com.github.breadmoirai.github-release' version '2.4.1'
}

使用Legacy Plugin Application

如果你的项目不使用Plugins DSL，可以在buildscript块中添加依赖：

buildscript {
    repositories {
        gradlePluginPortal()
    }
    dependencies {
        classpath 'com.github.breadmoirai:github-release:2.4.1'
    }
}

apply plugin: 'com.github.breadmoirai.github-release'

配置插件

示例配置以创建一个新的GitHub发布：

githubRelease {
    token 'YOUR_ACCESS_TOKEN' // 替换为你的GitHub个人访问令牌
    owner 'yourusername'       // 可选，默认为仓库所有者用户名
    repo 'yourrepo'            // 可选，默认为当前项目名
    tagName 'v1.0.0'           // 版本标签名
    releaseName 'Version 1.0.0' // 发布标题
    body '发布说明...'         // 自定义发布描述
    draft false               // 是否作为草稿发布
    prerelease false          // 是否标记为预发布版本
    releaseAssets 'path/to/asset.jar' // 要上传的资产路径
}

执行 ./gradlew githubRelease 即可发布到GitHub。

应用案例和最佳实践

自动化Changelog生成

利用插件的generateReleaseNotes功能，你可以自动将自从上次发布以来的Git提交信息合并到发布描述中，简化手动维护Changelog的过程：

githubRelease {
    generateReleaseNotes true
}

分布式任务与Dry Run

若需更复杂的发布流程，可以拆分任务并在发布前进行dry run测试：

githubRelease {
    dryRun true
}

之后再切换回false执行实际发布。

典型生态项目

虽然直接的相关“典型生态项目”未明确提及，但在 Gradle 生态系统内，类似的工作流通常结合CI/CD工具如Jenkins、GitHub Actions或者Travis CI来实现自动化版本管理和部署。例如，在GitHub Actions中，触发器可以配置为在每次成功构建后执行这个Gradle任务，自动完成新版本的发布，确保每个发布都经过了完整的测试流程。

---

通过上述步骤，您可以有效地在基于Gradle的项目中集成GitHub Release插件，自动化您的软件发布过程。记得替换示例中的占位符，以匹配您具体的GitHub仓库设置和发布需求。