npm-demo-release-please
v1.0.2
Published
Demo library showcasing Release Please automation
Readme
npm-demo-release-please
Demo library showcasing Release Please automation for NPM package publishing.
Features
- ✅ PR-based release workflow using Google's Release Please
- ✅ Automatic changelog generation from conventional commits
- ✅ GitHub native integration with manifest-based configuration
- ✅ Feature branch publishing with custom NPM dist-tags
- ✅ Automatic cleanup of feature branch aliases
Usage
import { hello } from 'npm-demo-release-please';
console.log(hello('World')); // "Hello, World!"Release Workflow
Main Branch
- Commits are made using conventional commit messages
- Release Please analyzes commits and creates a release PR
- When the release PR is merged, a new version is automatically published
Feature Branches
Pushes to feature/** or feat/** branches publish pre-release versions with branch-specific NPM tags.
Commit Message Format
This project follows Conventional Commits:
feat:- New features (minor version bump)fix:- Bug fixes (patch version bump)feat!:orBREAKING CHANGE:- Breaking changes (major version bump)
Example Scenarios
- Feature Release:
feat: add new greeting function - Bug Fix:
fix: handle empty name parameter - Breaking Change:
feat!: change function signature - Feature Branch: Push to
feature/awesome-feature→ Published as[email protected]
Release Please Workflow
- Make commits using conventional commit format
- Release Please bot creates/updates a release PR
- Review and merge the release PR
- Package is automatically published to NPM
Learn More
This demo repository is featured in the comprehensive guide: "The Ultimate Guide to NPM Release Automation: Semantic Release vs Release Please vs Changesets" - a detailed comparison of different NPM release automation tools with practical examples.
