Skip to content

Latest commit

 

History

History

.bumpy

README.md

🐸 Bumpy

This directory is used by bumpy to manage versioning and changelogs.

Bumpy is a modern versioning tool for JavaScript/TypeScript projects (monorepos and single packages). It uses bump files — small markdown files in this directory — to declare pending version changes. These files are consumed during the release process to compute version bumps, update changelogs, and publish packages.

How it works

  1. When you make a change that should trigger a release, create a bump file (typically one per PR)
  2. Bump files accumulate on your main branch until you're ready to release
  3. At release time, bumpy merges all pending bumps into a release plan, updates versions and changelogs, and publishes packages

Creating bump files

Interactive

bunx bumpy add

Non-interactive (useful for AI-assisted development)

bunx bumpy add --packages "package-name:minor,other-package:patch" --message "Description of changes" --name "my-change"

By hand

Create a .md file in this directory with YAML frontmatter mapping package names to bump levels (major, minor, patch, or none), and a markdown body for the changelog entry:

---
'package-name': minor
---

Added a new feature.

From conventional commits

bunx bumpy generate

Empty bump files

For PRs that intentionally don't need a release (docs, CI, etc.):

bunx bumpy add --empty --name "docs-update"

Keeping bump files up to date

As a PR evolves, make sure its bump file stays in sync. If the scope of changes grows (e.g., a patch becomes a new feature), update the bump level and description to match. Reviewers and AI assistants should treat the bump file as part of the PR — just like tests and docs.

Files in this directory

  • _config.json — bumpy configuration
  • README.md — this file
  • *.md (other than README.md) — pending bump files

📖 Full documentation: https://bumpy.varlock.dev