Skip to content

Commit 0657703

Browse files
committed
Fix docs typos and inaccuracies
- cli.md: fix `bumpy version` claiming `commit: true` is a config option (it's a `--commit` CLI flag), add missing flag table - differences-from-changesets.md, README.md: fix `@changesets/changesets` references (not a real npm package name)
1 parent 06a375e commit 0657703

3 files changed

Lines changed: 8 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ Tools like semantic-release infer version bumps from commit messages (`feat:`
226226

227227
## Why not just use changesets?
228228

229-
Bumpy is built as a successor to [@changesets/changesets](https://github.com/changesets/changesets). Changesets is mature and widely adopted, but has stagnated - hundreds of open issues around core design problems that are unlikely to be fixed without a rewrite. See [differences from changesets](https://github.com/dmno-dev/bumpy/blob/main/docs/differences-from-changesets.md) for a detailed comparison with links to specific issues. The biggest pain points bumpy addresses:
229+
Bumpy is built as a successor to [changesets](https://github.com/changesets/changesets). Changesets is mature and widely adopted, but has stagnated - hundreds of open issues around core design problems that are unlikely to be fixed without a rewrite. See [differences from changesets](https://github.com/dmno-dev/bumpy/blob/main/docs/differences-from-changesets.md) for a detailed comparison with links to specific issues. The biggest pain points bumpy addresses:
230230

231231
- **Sane dependency propagation** - changesets hardcodes aggressive behavior where a minor bump triggers a major bump on all peer dependents. Bumpy uses a [three-phase algorithm](https://github.com/dmno-dev/bumpy/blob/main/docs/version-propagation.md) with sensible defaults and full configurability.
232232
- **Workspace protocol resolution** - changesets uses `npm publish` even in pnpm/yarn workspaces, so `workspace:^` and `catalog:` protocols are NOT resolved, resulting in broken published packages.

docs/cli.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,17 @@ Consume all pending bump files and apply the release plan:
6565
3. Generates CHANGELOG.md entries
6666
4. Deletes consumed bump files
6767
5. Updates the lockfile
68-
6. Optionally commits (if `commit: true` in config)
68+
6. Optionally commits (with `--commit` flag)
6969

7070
```bash
7171
bumpy version
72+
bumpy version --commit
7273
```
7374

75+
| Flag | Description |
76+
| ---------- | --------------------------------- |
77+
| `--commit` | Commit the version changes to git |
78+
7479
## `bumpy publish`
7580

7681
Publish packages that have been versioned but not yet published. For each package, bumpy packs a tarball (resolving `workspace:` and `catalog:` protocols), publishes it, creates a git tag, and after all packages are published, pushes tags and creates GitHub releases.

docs/differences-from-changesets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Differences from Changesets
22

3-
Bumpy is built as a modern successor to [@changesets/changesets](https://github.com/changesets/changesets). This document tracks the pain points, missing features, and design problems in changesets that bumpy addresses (or plans to address), with links back to the relevant GitHub issues.
3+
Bumpy is built as a modern successor to [changesets](https://github.com/changesets/changesets). This document tracks the pain points, missing features, and design problems in changesets that bumpy addresses (or plans to address), with links back to the relevant GitHub issues.
44

55
---
66

0 commit comments

Comments
 (0)