Documentation
Getting started
- 1.Install the GitHub App on your repositories
- 2.Push commits to your default branch using conventional commit messages
- 3.pls detects your commits, calculates the version, and opens a release PR automatically
How it works
When you push to your default branch, pls analyzes your commits since the last release:
- Detects commits since the last release tag
- Calculates the version bump based on conventional commit types
- Opens (or updates) a release PR on the
pls-releasebranch - When you merge the PR, pls creates a git tag and GitHub Release with a generated changelog
Conventional commits
pls uses your commit messages to determine the version bump. Prefix your commits with a type:
| Prefix | Bump | Example |
|---|---|---|
| feat: | minor | 1.0.0 → 1.1.0 |
| fix: | patch | 1.0.0 → 1.0.1 |
| breaking change | major | 1.0.0 → 2.0.0 |
Other commit types (chore:, docs:, refactor:, etc.) are included in the changelog but don't trigger a version bump on their own.
Pre-releases
pls supports pre-release stages. When a release PR is open, you can select a different version using checkboxes in the PR body:
stable:1.1.0 → alpha:1.1.0-alpha.0 → beta:1.1.0-beta.0 → rc:1.1.0-rc.0
Configuration
pls works with zero configuration for most projects. If you need to customize behavior, add a pls.json file to your repository root. See the CLI documentation for available options.