Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .bumpy/_config.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"$schema": "../packages/bumpy/config-schema.json",
"baseBranch": "main",
"changelog": ["github", { "internalAuthors": ["theoephraim", "philmillman"] }]
"changelog": ["github", { "internalAuthors": ["theoephraim", "philmillman"] }],
"changedFilePatterns": ["src/**", "skills/**", "package.json", "tsconfig.json", "tsdown.config.ts"]
}
5 changes: 5 additions & 0 deletions .bumpy/json-schema-and-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@varlock/bumpy': minor
---

Add published JSON schema for config file with editor autocomplete/validation. New config options: `changedFilePatterns` (root + per-package) for filtering which file changes trigger package detection, `commit` object form for custom commit messages, and `changelog: false` to disable changelog generation.
6 changes: 5 additions & 1 deletion bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

73 changes: 42 additions & 31 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,26 @@ Bumpy is configured via `.bumpy/_config.json`, created by `bumpy init`. Per-pack

## Global config (`.bumpy/_config.json`)

| Option | Type | Default | Description |
| ---------------------------- | -------------------------------------- | -------------------------------- | ----------------------------------------------------------------------------------- |
| `baseBranch` | `string` | `"main"` | Branch used for release comparisons |
| `access` | `"public" \| "restricted"` | `"public"` | Default npm publish access level |
| `changelog` | `string \| [string, options]` | `"default"` | Changelog formatter — `"default"`, `"github"`, or path to a custom formatter |
| `fixed` | `string[][]` | `[]` | Package groups that always bump together to the same version |
| `linked` | `string[][]` | `[]` | Package groups that share the highest bump level |
| `ignore` | `string[]` | `[]` | Package name globs to exclude from versioning |
| `include` | `string[]` | `[]` | Package name globs to explicitly include (overrides `ignore` and `privatePackages`) |
| `privatePackages` | `{ version, tag }` | `{ version: false, tag: false }` | Whether to version and/or create git tags for private packages |
| `updateInternalDependencies` | `"patch" \| "minor" \| "out-of-range"` | `"out-of-range"` | When to update internal dependency version ranges |
| `dependencyBumpRules` | `object` | see below | Controls how bumps propagate through dependency types |
| `aggregateRelease` | `boolean \| { enabled, title }` | `false` | Create a single GitHub release instead of one per package |
| `commit` | `boolean` | `false` | Auto-commit changes after `bumpy version` |
| `publish` | `object` | see below | Publishing pipeline config |
| `gitUser` | `{ name, email }` | bumpy-bot | Git identity for CI commits |
| `versionPr` | `{ title, branch, preamble }` | see below | Customize the version PR |
| `allowCustomCommands` | `boolean \| string[]` | `false` | Allow per-package custom commands from `package.json` (see below) |
| `packages` | `object` | `{}` | Per-package config overrides (keyed by package name) |
| Option | Type | Default | Description |
| ---------------------------- | -------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------ |
| `baseBranch` | `string` | `"main"` | Branch used for release comparisons |
| `access` | `"public" \| "restricted"` | `"public"` | Default npm publish access level |
| `changelog` | `false \| string \| [string, options]` | `"default"` | Changelog formatter — `"default"`, `"github"`, path to a custom formatter, or `false` to disable |
| `fixed` | `string[][]` | `[]` | Package groups that always bump together to the same version |
| `linked` | `string[][]` | `[]` | Package groups that share the highest bump level |
| `ignore` | `string[]` | `[]` | Package name globs to exclude from versioning |
| `include` | `string[]` | `[]` | Package name globs to explicitly include (overrides `ignore` and `privatePackages`) |
| `privatePackages` | `{ version, tag }` | `{ version: false, tag: false }` | Whether to version and/or create git tags for private packages |
| `updateInternalDependencies` | `"patch" \| "minor" \| "out-of-range"` | `"out-of-range"` | When to update internal dependency version ranges |
| `dependencyBumpRules` | `object` | see below | Controls how bumps propagate through dependency types |
| `aggregateRelease` | `boolean \| { enabled, title }` | `false` | Create a single GitHub release instead of one per package |
| `versionCommitMessage` | `string` | — | Customize the version commit message (see below) |
| `changedFilePatterns` | `string[]` | `["**"]` | Glob patterns to filter which changed files count toward marking a package as changed |
| `publish` | `object` | see below | Publishing pipeline config |
| `gitUser` | `{ name, email }` | bumpy-bot | Git identity for CI commits |
| `versionPr` | `{ title, branch, preamble }` | see below | Customize the version PR |
| `allowCustomCommands` | `boolean \| string[]` | `false` | Allow per-package custom commands from `package.json` (see below) |
| `packages` | `object` | `{}` | Per-package config overrides (keyed by package name) |

### Dependency bump rules

Expand All @@ -46,6 +47,15 @@ Set a dependency type to `false` to disable propagation entirely.

See [version-propagation.md](version-propagation.md) for the full propagation algorithm.

### Version commit message

Customize the commit message used when versioning — both by `bumpy version --commit` and CI commands. Omit to use the default ("Version packages" + list of releases).

- `"My release"` — static commit message string
- `"./scripts/commit-msg.ts"` — path to a module (starts with `./` or `../`) that exports a function receiving the release plan and returning a message string

To auto-commit locally, pass the `--commit` flag: `bumpy version --commit`. CI commands always commit and push automatically.

### Publishing config

The `publish` object controls how packages are packed and published:
Expand Down Expand Up @@ -76,17 +86,18 @@ Per-package settings can be defined in two places:

`package.json` settings take precedence over global config.

| Option | Type | Description |
| --------------------- | -------------------------- | ----------------------------------------------------------------------- |
| `managed` | `boolean` | Opt this package in or out of versioning |
| `access` | `"public" \| "restricted"` | Override the global access level |
| `publishCommand` | `string \| string[]` | Custom command(s) to publish this package (replaces npm publish) |
| `buildCommand` | `string` | Command to run before publishing |
| `registry` | `string` | Custom npm registry URL |
| `skipNpmPublish` | `boolean` | Don't publish to npm (still creates git tags) |
| `checkPublished` | `string` | Custom command that outputs the currently published version |
| `dependencyBumpRules` | `object` | Per-package override for dependency propagation rules |
| `cascadeTo` | `object` | Explicit cascade targets — glob pattern mapped to `{ trigger, bumpAs }` |
| Option | Type | Description |
| --------------------- | -------------------------- | ---------------------------------------------------------------------------- |
| `managed` | `boolean` | Opt this package in or out of versioning |
| `access` | `"public" \| "restricted"` | Override the global access level |
| `publishCommand` | `string \| string[]` | Custom command(s) to publish this package (replaces npm publish) |
| `buildCommand` | `string` | Command to run before publishing |
| `registry` | `string` | Custom npm registry URL |
| `skipNpmPublish` | `boolean` | Don't publish to npm (still creates git tags) |
| `checkPublished` | `string` | Custom command that outputs the currently published version |
| `changedFilePatterns` | `string[]` | Glob patterns for changed-file detection (replaces root setting, not merged) |
| `dependencyBumpRules` | `object` | Per-package override for dependency propagation rules |
| `cascadeTo` | `object` | Explicit cascade targets — glob pattern mapped to `{ trigger, bumpAs }` |

### Custom commands and `allowCustomCommands`

Expand Down Expand Up @@ -155,7 +166,7 @@ Or in the package's `package.json` (requires `allowCustomCommands`):

## Changelog formatters

Set `changelog` in config to control how changelog entries are generated. Built-in options are `"default"` and `"github"`, or you can provide a path to a custom formatter module.
Set `changelog` in config to control how changelog entries are generated. Built-in options are `"default"` and `"github"`, or you can provide a path to a custom formatter module. Set to `false` to disable changelog generation entirely.

See the [Changelog Formatters](./changelog-formatters.md) docs for full details and examples.

Expand Down
Loading