快速开始

English | 简体中文

1. 构建 CLI

mvn -q test

2. 准备目标仓库

你的目标仓库至少需要满足：

• 已初始化 git
• 有根 pom.xml
• 有 <revision> 属性
• 有 CHANGELOG.md，或者让 javachanges 在应用 release plan 时自动创建/更新
• 根 pom.xml 中要么有 <modules>，要么是单模块根 artifact

3. 创建 changeset

Monorepo 示例：

mvn -q -DskipTests compile exec:java -Dexec.args="add --directory /path/to/repo --summary 'add release notes command' --release minor --modules core"

单模块示例：

mvn -q -DskipTests compile exec:java -Dexec.args="add --directory /path/to/repo --summary 'add release notes command' --release minor"

这个命令会往 .changesets/ 写入一个 Markdown 文件。

最短手写格式：

---
release: patch
summary: fix release-notes rendering
---

- Explain the change here.

默认值：

• type 默认 other
• modules 默认 all
• 如果省略 summary，会回退到正文第一条非空行

4. 查看计划

mvn -q -DskipTests compile exec:java -Dexec.args="plan --directory /path/to/repo"

5. 应用计划

mvn -q -DskipTests compile exec:java -Dexec.args="plan --directory /path/to/repo --apply true"

应用后会更新：

• 根 revision
• CHANGELOG.md
• .changesets/release-plan.json
• .changesets/release-plan.md