Skip to content
DesterLib Logo DesterLib Docs

Quick Reference

A quick reference guide for common versioning tasks with Changesets.

Quick Commands

Section titled “Quick Commands”
Terminal window
# Add a changeset for your changes
pnpm changeset


# Check what will be versioned
pnpm changeset:status


# Apply version bumps (maintainers only)
pnpm version


# Build and publish (maintainers only)
pnpm release

When to Use Each Bump Type

Section titled “When to Use Each Bump Type”

Patch (0.0.X) - Bug Fixes

Section titled “Patch (0.0.X) - Bug Fixes”
  • 🐛 Bug fixes
  • 📝 Documentation
  • 🎨 Style/formatting
  • ♻️ Refactoring (no API change)
  • ⚡ Performance (no breaking change)

Example:

🦋  Summary: Fix authentication token expiry bug
🦋  Bump: patch

Minor (0.X.0) - New Features

Section titled “Minor (0.X.0) - New Features”
  • ✨ New features
  • 🔥 Deprecations
  • 🚀 Enhancements
  • 📦 New optional parameters

Example:

🦋  Summary: Add user profile image upload endpoint
🦋  Bump: minor

Major (X.0.0) - Breaking Changes

Section titled “Major (X.0.0) - Breaking Changes”
  • 💥 Breaking API changes
  • ❌ Removed features
  • 🔄 Changed behavior
  • ⚠️ Required parameter changes

Example:

🦋  Summary: Replace REST auth with OAuth2 (BREAKING)
🦋  Bump: major

Changeset Flow

Section titled “Changeset Flow”
Make Changes → Create Changeset → Commit & Push → Create PR to main
    → Review & Merge → Auto Deploy (docs) → Version Bump → Release

Example Changeset File

Section titled “Example Changeset File”
---
"api": minor
---


Add WebSocket support for real-time notifications


- New `/ws` endpoint for WebSocket connections
- Real-time event streaming
- Connection management utilities

Commit Message Examples

Section titled “Commit Message Examples”

Using pnpm commit:

Terminal window
# Feature
feat(api): add user search endpoint


# Bug fix
fix(api): resolve JWT validation error


# Breaking change
feat(api)!: redesign authentication API


BREAKING CHANGE: Replace /auth/login with OAuth2

PR Workflow

Section titled “PR Workflow”

  1. Create feature branch from main

    Terminal window
    git checkout main && git pull
    git checkout -b feat/my-feature

  2. Make changes and commit

    Terminal window
    git add .
    pnpm commit

  3. Add changeset

    Terminal window
    pnpm changeset
    git add .changeset
    git commit -m "chore: add changeset"

  4. Push and create PR

    Terminal window
    git push -u origin feat/my-feature

  5. After merge to main

    Terminal window
    # Docs auto-deploy via GitHub Actions
    # Version bump via automated PR when ready
    git commit -am "chore: version packages"

  6. Merge to main → auto-release

Tips

Section titled “Tips”

✅ DO

Section titled “✅ DO”
  • Create changesets for user-facing changes
  • Write clear, descriptive summaries
  • One changeset per logical change
  • Review generated CHANGELOGs

❌ DON’T

Section titled “❌ DON’T”
  • Skip changesets for features/fixes
  • Bundle multiple features in one changeset
  • Forget to commit the changeset file
  • Edit CHANGELOGs manually

Common Tasks

Section titled “Common Tasks”

Check Pending Changes

Section titled “Check Pending Changes”
Terminal window
pnpm changeset:status

Add Changeset for Multiple Packages

Section titled “Add Changeset for Multiple Packages”
Terminal window
pnpm changeset
# Select multiple packages when prompted

View Changesets

Section titled “View Changesets”
Terminal window
ls .changeset/*.md
cat .changeset/some-changeset.md

Undo a Changeset

Section titled “Undo a Changeset”

Simply delete the changeset file:

Terminal window
rm .changeset/some-changeset.md

Need Help?

Section titled “Need Help?”