Skip to content

Commit 268a67c

Browse files
theoephraimclaude
andcommitted
Update docs: fix config paths, add gitUser/versionPr docs, fix deps claim
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 3ab422c commit 268a67c

2 files changed

Lines changed: 20 additions & 4 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ By default, bumpy uses your package manager to pack a tarball (resolving `worksp
4242
- **Configurable propagation** — the dependency bump algorithm is the core differentiator
4343
- **Node.js compatible** — developed with Bun but runs on Node.js too
4444
- **All package managers** — npm, pnpm, yarn, and bun workspaces
45-
- **Minimal dependencies**only `semver` and `js-yaml`
45+
- **Zero runtime dependencies**all dependencies are bundled
4646

4747
## Getting Started
4848

llms.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,22 @@ Added new encryption provider. Plugins need a patch bump for compatibility.
156156
// true = single aggregated release for all packages
157157
// { enabled: true, title: "Release {{date}}" } = aggregate with custom title
158158
"aggregateRelease": false,
159+
160+
// Git identity for CI commits (default: bumpy-bot)
161+
"gitUser": {
162+
"name": "bumpy-bot",
163+
"email": "276066384+bumpy-bot@users.noreply.github.com",
164+
},
165+
166+
// Version PR settings
167+
"versionPr": {
168+
// PR title (default: "🐸 Versioned release")
169+
"title": "🐸 Versioned release",
170+
// Branch name (default: "bumpy/version-packages")
171+
"branch": "bumpy/version-packages",
172+
// Preamble text shown at the top of the PR body
173+
"preamble": "Merge this PR when you are ready to release...",
174+
},
159175
}
160176
```
161177

@@ -247,7 +263,7 @@ The critical difference: changesets bumps dependents to **major** when a peer de
247263

248264
### `bumpy init`
249265

250-
Creates `.bumpy/` directory with default `config.json` and a README.
266+
Creates `.bumpy/` directory with default `_config.json` and a README.
251267

252268
### `bumpy add`
253269

@@ -346,7 +362,7 @@ Migrate from `.changeset/` to `.bumpy/`.
346362
| --------- | ---------------------------------------------------------- |
347363
| `--force` | Skip interactive prompts (don't ask to delete .changeset/) |
348364

349-
Migrates config.json fields, pending changeset files, and prints key differences from changesets.
365+
Migrates `.changeset/config.json` fields to `.bumpy/_config.json`, copies pending changeset files, and prints key differences from changesets.
350366

351367
## Changelog Customization
352368

@@ -625,7 +641,7 @@ bumpy migrate
625641

626642
This will:
627643

628-
1. Create `.bumpy/` and migrate `config.json` settings
644+
1. Create `.bumpy/` and migrate settings to `_config.json`
629645
2. Copy pending changeset `.md` files
630646
3. Optionally remove `.changeset/` directory
631647

0 commit comments

Comments
 (0)