Getting Started

English | 简体中文

1. Build the CLI

mvn -q test

2. Prepare a target repository

Your target repository should have:

• git initialized
• a root pom.xml
• a <revision> property
• a CHANGELOG.md file, or let javachanges create/update it during plan application
• either <modules> in the root pom, or a single root artifact

3. Create a changeset

Monorepo example:

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

Single-module example:

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

This writes a markdown file into .changesets/.

Shortest hand-written format:

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

- Explain the change here.

Defaults:

• type defaults to other
• modules defaults to all
• summary falls back to the first non-empty body line if omitted

4. Inspect the plan

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

5. Apply the plan

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

That updates:

• the root revision
• CHANGELOG.md
• .changesets/release-plan.json
• .changesets/release-plan.md