Skip to main content
← Back to workflows

How to Automate Releases with Conventional Commit Messages?

googleapis-release-please-action -
GitHub Action
v4.1.1
1,471
Contributors
Contributor - bcoe
CICUBE ANALYTICS INSIGHTS
Engineering Velocity: 25% Team Time Lost to CI Issues
View Platform →
3.5h
Time Saved/Dev/Week
40%
Faster Releases
Click for next insight
Usage
name: 'Usage of Release Please GitHub Action'
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: google-github-actions/release-please-action@v4
with:
# this assumes that you have created a personal access token
# (PAT) and configured it as a GitHub action secret named
# `MY_RELEASE_PLEASE_TOKEN` (this secret name is not important).
token: ${{ secrets.MY_RELEASE_PLEASE_TOKEN }}
# this is a built-in strategy in release-please, see "Action Inputs"
# for more options
release-type: simple

release-please-action logo

Release Please

Automated releases based on conventional commits


What is Release Please?

The release-please-action leverages conventional commit messages to determine version bumps and generate release notes automatically. This means that the version numbers and the changelog are automatically generated based on the commits since the last release.

How to Customize Release Behavior

You can further customize how the release-please-action operates by adjusting additional settings:

- uses: GoogleCloudPlatform/release-please-action@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
release-type: 'node'
package-name: 'example-package'
bump-minor-pre-major: true
monorepo-tags: true
changelog-types: '[{"type":"feat","section":"Features"},{"type":"fix","section":"Bug Fixes"}]'

Bump Minor Pre Major: Enables minor version bumps before reaching major versions.

Monorepo Tags: Uses for monorepo support to tag each package individually.

Changelog Types: Customizes how different types of commits are displayed in the changelog.