🚀lazy-release

Automate versioning, publishing, and creating changelogs for Node.js projects

Using conventional commits and supports multi-package repos

Get Started View on GitHub 
pnpm i @lazy-release/cli -D
Contributors WelcomeNPM VersionLicense

✨ Features

📝

Automated Changelogs

Generate nice looking changelogs from conventional commits

🔖

Version Management

Automatic semantic versioning based on commit messages

🏷️

Git Tag Management

Automatically creates and publishes git version tags

📦

Package Manager Agnostic

Works with npm, pnpm, yarn, and bun

🤖

GitHub Integration

Automatic PR creation and GitHub releases

🧪

Snapshot Releases

Create preview versions for testing

🎯

Monorepo Support

Manage multiple packages in a single repository

⚡

Fast & Reliable

Built for speed and consistency in CI/CD environments

🔄 How It Works

A simple three-step automated release process

1

Merge Pull Request

A dev merges a Pull Request into the main branch using squash merge. The PR should be prefixed with conventional commit prefix (fix, feat, chore, etc.)

feat: add new feature
↓
2

Release PR Created

A Release PR gets automatically created with:

  • ✅ Bumped version in package.json files
  • ✅ Updated lock files
  • ✅ Created or updated changelogs
📝 Review the changes before merging
↓
3

Release Published

Once the Release PR is merged:

  • 📦 Packages published to npm (if NPM_TOKEN provided)
  • 🏷️ GitHub release created (if GITHUB_TOKEN provided)
  • 🎉 Version tags pushed to repository
🚀 Your release is live!

📖 Quick Start

💡

It's recommended to run lazy-release in a CI/CD environment (like GitHub Actions) for automated and consistent release workflows.

1. Install the CLI 

pnpm i @lazy-release/cli -D

2. Add a script to your package.json 

{
  "scripts": {
    "lazy-release": "lazy-release"
  }
}

3. Run the CLI 

pnpm lazy-release \
  --npm-token $NPM_TOKEN \
  --github-token $GITHUB_TOKEN \
  --access public

⚙️ Prerequisites

1. Use squash merge for pull requests

In your repo settings:

  • Go to Settings → General → Pull Requests
  • Uncheck "Allow merge commits"
  • Check "Allow squash merges"
  • Choose "Pull request title" for default commit message

2. Update workflow permissions

  • Go to Settings → Actions → General
  • Set "Workflow permissions" to "Read and write permissions"
  • Check "Allow GitHub Actions to create and approve pull requests"
📚 Read Full Documentation

🌟 Projects Using lazy-release

📝

NoteX

Modern note-taking application

🎨

vscode-jetbrains-icon-theme

JetBrains icon theme for VS Code

Using lazy-release in your project? Add it to this list!