sbt-release 使用与技术文档

本文档旨在帮助用户了解并使用 sbt-release 插件，这是一个可定制的发布流程插件，可以添加到您的项目中。以下内容将详细介绍安装指南、使用说明以及 API 使用文档。

1. 安装指南

在开始使用 sbt-release 之前，您需要确保满足以下条件：

• sbt 1.x 版本
• 项目版本遵循语义化版本控制方案 semver.org，并可以有额外的补充。
• 配置一个发布仓库（publish repository），默认发布流程需要。
• git（可选）

确保您的项目环境满足以上要求后，通过以下方式添加 sbt-release 插件到您的项目中：

addSbtPlugin("com.github.sbt" % "sbt-release" % "1.4.0")

在 project/plugins.sbt 文件中添加上述代码。

2. 项目的使用说明

使用 sbt-release 非常简单。首先，您需要在 version.sbt 文件中设置项目的版本。sbt-release 默认情况下不会修改您的构建定义文件，而是将新发布的版本或开发版本写入由设置 releaseVersionFile 指定的文件中，默认为 $PROJECT_ROOT/version.sbt。

以下是 sbt-release 默认的发布流程：

1. 检查工作目录是否为 git 仓库并且没有未提交的更改，同时打印最后提交的哈希值。
2. 如果存在任何快照依赖，询问用户是否继续。
3. 询问用户发布版本和下一个开发版本，提供合理的默认值。
4. 执行 clean。
5. 执行 test:test，如果有测试失败，发布流程将终止。
6. 将发布版本写入 version.sbt 并应用于当前构建状态。
7. 提交 version.sbt 的更改。
8. 使用 v版本号 标记之前的提交。
9. 执行 publish。
10. 将下一个开发版本写入 version.sbt 并应用于当前构建状态。
11. 提交 version.sbt 的更改。

发布过程中的任何任务失败都将导致发布流程中断。

3. 项目 API 使用文档

sbt-release 的 API 使用主要通过 sbt 的命令行接口。以下是一些常用的命令和参数：

• release：执行发布流程。
• release with-defaults：使用默认值执行非交互式发布。
• release release-version <version> next-version <version>：设置发布版本和下一个开发版本。
• release skip-tests：在紧急情况下跳过测试执行发布。
• release cross：触发跨构建发布。

更多关于 sbt-release 的配置和自定义，请参考项目文档和 GitHub 上的 Wiki 页面。

4. 项目安装方式

安装 sbt-release 插件的方式已在安装指南中说明。确保您已经将插件添加到 project/plugins.sbt 文件中，并遵循了项目的版本要求。

通过遵循本文档中的指南，您应该能够成功地安装、配置并使用 sbt-release 插件来管理您的项目发布流程。如果在使用过程中遇到任何问题，请查阅项目文档或在 GitHub 上创建一个 issue。