Skip to content

Commit cdba9eb

Browse files
committed
docs: mark prerelease channels as shipped in README
- add to Features and Documentation sections - add to changesets pain-points comparison - remove from Roadmap (now implemented)
1 parent e02189f commit cdba9eb

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Fixed locale fallback logic in utils.
5454
- **Flexible package management** - include/exclude any package individually via per-package config, glob patterns, or `privatePackages` setting
5555
- **Non-interactive CLI** - `bumpy add` works fully non-interactively for CI/CD and AI-assisted development
5656
- **Aggregated GitHub releases** - optionally create a single consolidated release instead of one per package
57+
- **Prerelease channels** - branch-based `@next` / `@beta` release lines where prerelease versions are derived at publish time, never committed to git (see [prerelease channels docs](https://github.com/dmno-dev/bumpy/blob/main/docs/prereleases.md))
5758
- **Auto-generate from commits** - `bumpy generate` creates bump files from branch commits - works with any commit style, with enhanced detection for conventional commits
5859
- **Pluggable changelog formatters** - built-in `"default"` and `"github"` formatters, or write your own
5960
- **Zero runtime dependencies** - dependencies are minimal and bundled at release time
@@ -119,6 +120,7 @@ The skill teaches the AI to examine git changes, identify affected packages, cho
119120
- [CLI reference](https://github.com/dmno-dev/bumpy/blob/main/docs/cli.md) - every command with flags and examples
120121
- [GitHub Actions setup](https://github.com/dmno-dev/bumpy/blob/main/docs/github-actions.md) - CI workflows, token setup, trusted publishing
121122
- [Version propagation](https://github.com/dmno-dev/bumpy/blob/main/docs/version-propagation.md) - how dependency bumps cascade through your graph
123+
- [Prerelease channels](https://github.com/dmno-dev/bumpy/blob/main/docs/prereleases.md) - branch-based `@next` / `@beta` release lines
122124

123125
## Why files instead of conventional commits?
124126

@@ -133,6 +135,7 @@ Bumpy is built as a successor to [🦋changesets](https://github.com/changesets/
133135
- **Custom publish commands** - changesets is hardcoded to `npm publish`. Bumpy supports per-package custom publish for VSCode extensions, Docker images, JSR, etc.
134136
- **Flexible package management** - changesets treats all private packages the same. Bumpy lets you include/exclude any package individually.
135137
- **CI without a separate action or bot** - changesets requires installing a [GitHub App](https://github.com/apps/changeset-bot) _and_ using a [separate GitHub Action](https://github.com/changesets/action). Bumpy replaces both with two CLI commands (`bumpy ci check` + `bumpy ci release`) that run directly in your workflows - no extra repos to trust, no app installation requiring org admin approval.
138+
- **Prerelease channels that don't corrupt state** - changesets' prerelease mode is described in [their own docs](https://github.com/changesets/changesets/blob/main/docs/prereleases.md) as "very complicated" with states "very hard to fix." Bumpy uses [branch-based channels](https://github.com/dmno-dev/bumpy/blob/main/docs/prereleases.md) where prerelease versions are never committed - no global mode file to poison unrelated releases.
136139
- **Automatic migration** - `bumpy init` detects `.changeset/`, renames it to `.bumpy/`, migrates config, keeps pending files, and offers to uninstall `@changesets/cli`.
137140

138141
## Development
@@ -146,7 +149,6 @@ bunx bumpy --help # invoke built cli
146149

147150
## Roadmap
148151

149-
- Prerelease mode (for now, use [pkg.pr.new](https://github.com/stackblitz-labs/pkg.pr.new) for branch preview packages)
150152
- Standalone binary for use outside of JS projects
151153
- Better support for versioning non-JS packages and usage without package.json files
152154
- Plugin system for different publish targets, and support multiple targets per package

0 commit comments

Comments
 (0)