Skip to content

Commit 42fea98

Browse files
docs: document version dry run
1 parent fd4d462 commit 42fea98

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,30 @@ cargo install --git https://github.com/Open-Tech-Foundation/release
3434
| Command | Status | What it does |
3535
| --- | --- | --- |
3636
| `otf-release init` | ✅ Supported | Interactive setup. Writes `release.toml`, `.github/workflows/release.yml`, and `.github/workflows/snapshot.yml`. |
37-
| `otf-release version` | ✅ Supported | Interactive local release flow. Select packages, choose bumps, cascade dependents, update manifests/changelogs, push a release branch, and open a PR. |
37+
| `otf-release version` | ✅ Supported | Interactive local release flow. Use `--dry-run` to preview the plan without writing files, and `--first-release` when a package has no prior matching tag. |
3838
| `otf-release publish` | ✅ Supported | CI-oriented publish flow. Publishes in dependency order, skips already-published versions, creates `name@version` tags, and creates package releases from notes. |
3939
| `otf-release snapshot` | 🧪 Experimental | Creates hash-based prerelease versions such as `1.2.3-snapshot.a1b2c3d` and publishes them from CI. |
4040
| `otf-release config` | ✅ Supported | Interactive editor for hooks, ecosystems, package build fields, generic package fields, provider, snapshot tag, changelog strategy, and GitHub Release notes. |
4141
| `otf-release upgrade` | ◐ Partial | Regenerates `release.yml` from the current `release.toml`. |
4242
| `otf-release self-update` | ✅ Supported | Checks GitHub Releases and reruns the install script when a newer CLI version exists. |
4343

44+
## Common Local Commands
45+
46+
Preview a release plan without editing files, committing, pushing, or opening a PR:
47+
48+
```bash
49+
otf-release version --dry-run
50+
```
51+
52+
Allow the first release of a publishable package that has no previous tag matching
53+
`release.toml`'s `tag_format`:
54+
55+
```bash
56+
otf-release version --first-release
57+
```
58+
59+
Curated changelog mode still requires non-empty `[Unreleased]` notes for packages being released.
60+
4461
## 🧩 Supported Adapters
4562

4663
| Adapter | Status | Notes |

0 commit comments

Comments
 (0)