| name | release-please-configuration |
| description | Configure automated versioning with release-please. Set up semantic versioning, changelog generation, and monorepo support using GitHub App token authentication. |
Release-Please Configuration
When to Use This Skill
Release-please reads your commit history and:
- Groups changes by type (feat, fix, chore, etc.)
- Generates changelogs
- Bumps versions according to semantic versioning
- Creates pull requests for releases
- Tags releases when PRs merge
Implementation
Release-please automates version management based on conventional commits. It creates release PRs with updated changelogs, version bumps, and Git tags.
Schema Validation
Always include the $schema property in your config file. It catches invalid options immediately and saves debugging time.
Overview
Release-please reads your commit history and:
- Groups changes by type (feat, fix, chore, etc.)
- Generates changelogs
- Bumps versions according to semantic versioning
- Creates pull requests for releases
- Tags releases when PRs merge
Configuration Files
release-please-config.json
The main configuration file defines packages and their versioning behavior:
See examples.md for detailed code examples.
.release-please-manifest.json
Tracks current versions for each package:
{
"charts/my-app": "1.0.0",
"packages/backend": "1.0.0",
"packages/frontend": "1.0.0"
}
Configuration Options
Global Options
| Option | Description | Example |
|---|
include-v-in-tag | Prefix tags with v | true = v1.0.0, false = 1.0.0 |
tag-separator | Separator between component and version | - = backend-1.0.0 |
separate-pull-requests | Create one PR per component | Recommended for monorepos |
changelog-sections | How to group commits in changelogs | See example above |
Package Options
| Option | Description | Values |
|---|
release-type | Package ecosystem | node, helm, simple, python, go, etc. |
component | Component name for tagging | Any string |
include-component-in-tag | Include component in tag | true = backend-1.0.0 |
package-name | Package name (for node, etc.) | Matches package.json name |
Schema Validation
Always validate configuration against the official schema:
{
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
}
This catches invalid options immediately. Options like release-name don't exist. The schema prevents wasted debugging time.
In This Section
Related
References
Overview
Release-please reads your commit history and:
- Groups changes by type (feat, fix, chore, etc.)
- Generates changelogs
- Bumps versions according to semantic versioning
- Creates pull requests for releases
- Tags releases when PRs merge
Configuration Files
release-please-config.json
The main configuration file defines packages and their versioning behavior:
See examples.md for detailed code examples.
.release-please-manifest.json
Tracks current versions for each package:
{
"charts/my-app": "1.0.0",
"packages/backend": "1.0.0",
"packages/frontend": "1.0.0"
}
Configuration Options
Global Options
| Option | Description | Example |
|---|
include-v-in-tag | Prefix tags with v | true = v1.0.0, false = 1.0.0 |
tag-separator | Separator between component and version | - = backend-1.0.0 |
separate-pull-requests | Create one PR per component | Recommended for monorepos |
changelog-sections | How to group commits in changelogs | See example above |
Package Options
| Option | Description | Values |
|---|
release-type | Package ecosystem | node, helm, simple, python, go, etc. |
component | Component name for tagging | Any string |
include-component-in-tag | Include component in tag | true = backend-1.0.0 |
package-name | Package name (for node, etc.) | Matches package.json name |
Schema Validation
Always validate configuration against the official schema:
{
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
}
This catches invalid options immediately. Options like release-name don't exist. The schema prevents wasted debugging time.
In This Section
Related
References
Examples
See examples.md for code examples.
Related Patterns
- Change Detection
- Workflow Triggers
- Content Comparison
References
