Release Please Action

Automate releases with Conventional Commit Messages.

Setting up this action

If you haven't already done so, create a .github/workflows folder in your repository (this is where your actions will live).

Now create a .github/workflows/release-please.yml file with these contents:

on:
  push:
    branches:
      - main

permissions:
  contents: write
  pull-requests: write

name: release-please

jobs:
  release-please:
    runs-on: ubuntu-latest
    steps:
      - uses: google-github-actions/release-please-action@v3
        with:
          release-type: node
          package-name: <your-package-name>

Merge the above action into your repository and make sure new commits follow the Conventional Commits convention, release-please will start creating Release PRs for you.
For an alternative configuration that provides easier bootstrapping options for initial setup, follow these instructions (ignore the cli section) and then configure this action as follows:
```
#...(same as above)
    steps:
      - uses: google-github-actions/release-please-action@v3
        with:
          command: manifest
```

Configuration

input	description
`token`	A GitHub secret token, the action defaults to using the special `secrets.GITHUB_TOKEN`
`release-type`	What type of project is this a release for? Reference Release types supported; new types of releases can be added here
`package-name`	A name for the artifact releases are being created for (this might be the `name` field in a `setup.py` or `package.json`)
`bump-minor-pre-major`	Should breaking changes before 1.0.0 produce minor bumps? Default `false`
`bump-patch-for-minor-pre-major`	Should feat changes before 1.0.0 produce patch bumps instead of minor bumps? Default `false`
`path`	create a release from a path other than the repository's root
`monorepo-tags`	add prefix to tags and branches, allowing multiple libraries to be released from the same repository.
`changelog-types`	A JSON formatted String containing to override the outputted changelog sections. Defined types may trigger version bumps.
`version-file`	provide a path to a version file to increment (used by ruby releaser)
`extra-files`	add extra-files to bump using the generic updater
`fork`	Should the PR be created from a fork. Default `false`
`command`	release-please command to run, either `github-release`, or `release-pr`, `manifest`, `manifest-pr` (defaults to running both)
`default-branch`	branch to open pull release PR against (detected by default)
`pull-request-title-pattern`	title pattern used to make release PR, defaults to using `chore${scope}: release${component} ${version}`.
`pull-request-header`	header used within the release PR body, defaults to using `:robot: I have created a release beep boop`.
`changelog-path`	configure alternate path for `CHANGELOG.md`. Default `CHANGELOG.md`
`github-api-url`	configure github API URL. Default `https://api.github.com`
`signoff`	Add `Signed-off-by` line at the end of the commit log message using the user and email provided. (format "Name <email@example.com>")
`repo-url`	configure github repository URL. Default `process.env.GITHUB_REPOSITORY`
`github-graphql-url`	configure github GraphQL URL. Default `https://api.github.com`
`changelog-notes-type`	Strategy for building the changelog contents. Default `default`. Called `changelog-type` in release-please documentation.
`changelog-host`	Host for commit hyperlinks in the changelog. Default `https://github.com`
`versioning-strategy`	Override method of determining SemVer version bumps based on commits. Default `default`
`release-as`	manually set version to this value, ignoring conventional commits. Absence defaults to conventional commits derived next version. Once the release PR is merged you should either remove this or update it to a higher version. Otherwise subsequent `manifest-pr` runs will continue to use this version even though it was already set in the last release.
`skip-github-release`	Skip creating GitHub Releases. Default `false`
`prerelease`	If set, create releases that are pre-major or pre-release version marked as pre-release on Github. Defaults `false`
`component`	Name of the component used for branch naming and release tagging. Defaults to a normalized version based on the package name
`include-v-in-tag`	include "v" in tag versions. Default `true`
`tag-separator`	configures separator character used in release tag
`snapshot-labels`	sets java snapshot pull request labels other than `autorelease: snapshot`
`bootstrap-sha`	if this is the first time running `manifest-pr` on a repo this key will limit how far back (exclusive) to pull commits for conventional commit parsing, see (the manifest releaser docs)[https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md]
`last-release-sha`	overrides the commit sha release-please will use from which to gather commits for the current release, see (the manifest releaser docs)[https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md]
`always-link-local`	when using the `node-workspace` plugin, setting to false will only bump your local dependencies within the SemVer range, see (the manifest releaser docs)[https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md] . Default `true`.
`separate-pull-requests`	create separate pull requests for each package instead of a single manifest release pull request, see (the manifest releaser docs)[https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md]. Default `false`.
`plugins`	see https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md#plugins
`labels`	list of labels to apply to the release pull requests, defaults to `autorelease: pending`
`release-labels`	set a pull request label other than `autorelease: tagged`
`skip-labeling`	if set, labels will not be applied to pull requests. Default `false`.
`sequential-calls`	issue GitHub API requests sequentially rather than concurrently, see (the manifest releaser docs)[https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md]. Default `false`
`group-pull-request-title-pattern`	sets the manifest pull request title for when releasing multiple packages grouped together in the one pull request
`release-search-depth`	when searching for the latest release SHAs, only consider the last N releases
`commit-search-depth`	when fetching the list of commits to consider, only consider the last N commits
`proxy-server`	set proxy sever when you run this action behind a proxy. format is host:port e.g. proxy-host.com:8080

GitHub credentials

release-please requires a GitHub token to access the GitHub API. You configure this token via the token configuration option.

Warning

If using GitHub Actions, you will need to specify a token for your workflows to run on Release Please's releases and PRs.

By default, Release Please uses the built-in GITHUB_TOKEN secret. However, all resources created by release-please (release tag or release pull request) will not trigger future GitHub actions workflows, and workflows normally triggered by release.created events will also not run. From GitHub's docs:

When you use the repository's GITHUB_TOKEN to perform tasks, events triggered by the GITHUB_TOKEN will not create a new workflow run. This prevents you from accidentally creating recursive workflow runs.

. You will want to configure a GitHub Actions secret with a Personal Access Token if you want GitHub Actions CI checks to run on Release Please PRs.

The `command` option

Some additional info regarding the command property.

github-release: creates GitHub releases (as mentioned here) based on the most recently merged release PR and the release strategy being used.
release-pr: uses Conventional Commits to propose a candidate release pull request. This pull request, once merged, is used by github-release/manifest
manifest: use source controlled files containing releaser specific configuration (the release-please-config.json) as well package version tracking (the .release-please-manifest.json).
manifest-pr: uses the manifest file release-please-config.json to propose a candidate release

Workflow Permissions

This workflow will need the following permissions in your workflow file:

permissions:
  contents: write
  pull-requests: write

You may also need to set "Allow GitHub Actions to create and approve pull requests" under repository Settings > Actions > General.

For more information about permissions:

Release types supported

Release Please automates releases for the following flavors of repositories:

release type	description
`elixir`	An elixir repository with a mix.exs and a CHANGELOG.md
`go`	Go repository, with a CHANGELOG.md
`helm`	A helm chart repository with a Chart.yaml and a CHANGELOG.md
`java`	A strategy that generates SNAPSHOT version after each release
`maven`	Strategy for Maven projects, generates SNAPSHOT version after each release and updates `pom.xml` automatically
`node`	A Node.js repository, with a package.json and CHANGELOG.md
`ocaml`	An OCaml repository, containing 1 or more opam or esy files and a CHANGELOG.md
`python`	A Python repository, with a setup.py, setup.cfg, version.py and CHANGELOG.md and optionally a pyproject.toml and a <project>/__init__.py
`php`	A php composer package with composer.json and CHANGELOG.md
`ruby`	A Ruby repository, with version.rb and CHANGELOG.md
`rust`	A Rust repository, with a Cargo.toml (either as a crate or workspace) and a CHANGELOG.md
`sfdx`	A repository with a sfdx-project.json and a CHANGELOG.md
`simple`	A repository with a version.txt and a CHANGELOG.md
`terraform-module`	A terraform module, with a version in the README.md, and a CHANGELOG.md

Outputs

Properties that are available after the action executed.

output	description
`releases_created`	`true` if the release was created, `false` otherwise
`upload_url`	Directly related to Create a release API
`html_url`	Directly related to Create a release API
`tag_name`	Directly related to Create a release API
`major`	Number representing major semver value
`minor`	Number representing minor semver value
`patch`	Number representing patch semver value
`sha`	sha that a GitHub release was tagged at
`pr`	The JSON string of the PullRequest object (undefined if no release created)
`prs`	The JSON string of the array of PullRequest objects (undefined if no release created)

How release please works

Release Please automates CHANGELOG generation, the creation of GitHub releases, and version bumps for your projects. Release Please does so by parsing your git history, looking for Conventional Commit messages, and creating release PRs.

What's a Release PR?

Rather than continuously releasing what's landed to your default branch, release-please maintains Release PRs:

These Release PRs are kept up-to-date as additional work is merged. When you're ready to tag a release, simply merge the release PR.

How should I write my commits?

Release Please assumes you are using Conventional Commit messages.

The most important prefixes you should have in mind are:

fix: which represents bug fixes, and correlates to a SemVer patch.
feat: which represents a new feature, and correlates to a SemVer minor.
feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.

Overriding the Changelog Sections

To output more commit information in the changelog, a JSON formatted String can be added to the Action using the changelog-types input parameter. This could look something like this:

on:
  push:
    branches:
      - main
name: release-please
jobs:
  release-please:
    runs-on: ubuntu-latest
    steps:
      - uses: google-github-actions/release-please-action@v3
        with:
          release-type: node
          package-name: release-please-action
          changelog-types: '[{"type":"feat","section":"Features","hidden":false},{"type":"fix","section":"Bug Fixes","hidden":false},{"type":"chore","section":"Miscellaneous","hidden":false}]'

Supporting multiple release branches

release-please has the ability to target not default branches. You can even use separate release strategies (release-type). To configure, simply configure multiple workflows that specify a different default-branch:

Configuration for main (default) branch (.github/workflows/release-main.yaml):

on:
  push:
    branches:
      - main
name: release-please
jobs:
  release-please:
    runs-on: ubuntu-latest
    steps:
      - uses: google-github-actions/release-please-action@v3
        with:
          release-type: node
          package-name: release-please-action

Configuration for 1.x (default) branch (.github/workflows/release-1.x.yaml):

on:
  push:
    branches:
      - 1.x
name: release-please
jobs:
  release-please:
    runs-on: ubuntu-latest
    steps:
      - uses: google-github-actions/release-please-action@v3
        with:
          release-type: node
          package-name: release-please-action
          default-branch: 1.x

Automating publication to npm

With a few additions, the Release Please action can be made to publish to npm when a Release PR is merged:

on:
  push:
    branches:
      - main
name: release-please
jobs:
  release-please:
    runs-on: ubuntu-latest
    steps:
      - uses: google-github-actions/release-please-action@v3
        id: release
        with:
          release-type: node
          package-name: test-release-please
      # The logic below handles the npm publication:
      - uses: actions/checkout@v2
        # these if statements ensure that a publication only occurs when
        # a new release is created:
        if: ${{ steps.release.outputs.release_created }}
      - uses: actions/setup-node@v1
        with:
          node-version: 12
          registry-url: 'https://registry.npmjs.org'
        if: ${{ steps.release.outputs.release_created }}
      - run: npm ci
        if: ${{ steps.release.outputs.release_created }}
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
        if: ${{ steps.release.outputs.release_created }}

So that you can keep 2FA enabled for npm publications, we recommend setting registry-url to your own Wombat Dressing Room deployment.

Creating major/minor tags

If you are using release-please to publish a GitHub action, you will likely want to tag a major and minor tag during a release, i.e., if you are releasing v2.8.3, you will also want to update tags v2 and v2.8. This allows your users to pin to v2, and get updates to your library without updating their workflows.

The release-please-action has the outputs major, minor, and release_created to facilitate this. These outputs can be used conditionally, like so:

on:
  push:
    branches:
      - main
name: release-please
jobs:
  release-please:
    runs-on: ubuntu-latest
    steps:
      - uses: google-github-actions/release-please-action@v3
        id: release
        with:
          release-type: node
          package-name: ${{env.ACTION_NAME}}
          command: github-release
      - uses: actions/checkout@v2
      - name: tag major and minor versions
        if: ${{ steps.release.outputs.release_created }}
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
          git remote add gh-token "https://${{ secrets.GITHUB_TOKEN }}@github.com/google-github-actions/release-please-action.git"
          git tag -d v${{ steps.release.outputs.major }} || true
          git tag -d v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} || true
          git push origin :v${{ steps.release.outputs.major }} || true
          git push origin :v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} || true
          git tag -a v${{ steps.release.outputs.major }} -m "Release v${{ steps.release.outputs.major }}"
          git tag -a v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} -m "Release v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}"
          git push origin v${{ steps.release.outputs.major }}
          git push origin v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}

Manifest release output

When using a manifest command the outputs are modified to have a general releases-created value to test if any releases were created. Package specific outputs can be accessed by using the package path prefixed output.

on:
  push:
    branches:
      - main
name: Run Release Please
jobs:
  release-please:
    runs-on: ubuntu-latest
    steps:
      - uses: google-github-actions/release-please-action@v3
        id: release
        with:
          command: manifest
      - run: echo "A release was created."
        if: ${{ steps.release.outputs.releases_created }}
      # For root level packages: ${{ steps.release.outputs.package-a--tag_name }}
      - run: echo "Release ${{ steps.release.outputs['packages/package-a--tag_name'] }} created for package-a."
        if: ${{ steps.release.outputs['packages/package-a--release_created'] }}

Updating additional files

You can update additional files with the extra-files input.

See the generic updater docs for more info on how release-please will update those files.

on:
  push:
    branches:
      - main
name: release-please
jobs:
  release-please:
    runs-on: ubuntu-latest
    steps:
      - uses: google-github-actions/release-please-action@v3
        with:
          release-type: node
          extra-files: |
            README.md
            docs/getting-started.md

Attaching files to the GitHub release

You can attach additional files, such as release artifacts, to the GitHub release that is created. The gh CLI tool, which is installed on all runners, can be used for this.

This example uses the gh tool to attach the file ./artifact/some-build-artifact.zip:

on:
  push:
    branches:
      - main
name: release-please
jobs:
  release-please:
    runs-on: ubuntu-latest
    steps:
      - uses: google-github-actions/release-please-action@v3
        id: release
        with:
          release-type: node
      - name: Upload Release Artifact
        if: ${{ steps.release.outputs.release_created }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run:
          gh release upload ${{ steps.release.outputs.tag_name }} ./artifact/some-build-artifact.zip

License

Apache Version 2.0

jbottigliero/release-please-action