release-please-action

> 编程语言

Open source

automated releases based on conventional commits

2.5K stars0 likes0 views

Website GitHub

About

automated releases based on conventional commits

Release Please Action

Automate releases with Conventional Commit Messages.

Basic Configuration

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

…

Specifying a release-type configuration is the most straight-forward configuration option, but allows for no further customization. For advanced configuration options, see the Advanced Configuration section

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.

Advanced Release Configuration

For any advanced configuration, please set up a manifest config and then configure this action as follows:

yaml

#...(same as above)
steps:
  - uses: googleapis/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 }}
      # optional. customize path to release-please-config.json
      config-file: release-please-config.json
      # optional. customize path to .release-please-manifest.json
      manifest-file: .release-please-manifest.json

Action Inputs

input	description
`token`	A GitHub secret token, the action defaults to using the special `secrets.GITHUB_TOKEN`
`release-type`	If specified, defines the release strategy to use for the repository. Reference Release types supported
`path`	create a release from a path other than the repository's root
`target-branch`	branch to open pull release PR against (detected by default)
`config-file`	Path to the release-please config in the repository. Defaults to `release-please-config.json`
`manifest-file`	Path to the release-please versions manifest. Defaults to `.release-please-manifest.json`
`repo-url`	GitHub repository name in the form of `<owner>/<repo>`. Defaults to the repository the action is running in.
`github-api-url`	Override the GitHub API URL.
`github-graphql-url`	Override the GitHub GraphQL URL
`fork`	If `true`, send the PR from a fork. This requires the `token` to be a user that can create forks (e.g. not the default `GITHUB_TOKEN`)
`include-component-in-tag`	If true, add prefix to tags and branches, allowing multiple libraries to be released from the same repository
`proxy-server`	Configure a proxy server in the form of `<host>:<port>` e.g. `proxy-host.com:8080`
`skip-github-release`	If `true`, do not attempt to create releases. This is useful if splitting release tagging from PR creation.
`skip-github-pull-request`	If `true`, do not attempt to create release pull requests. This is useful if splitting release tagging from PR creation.
`skip-labeling`	If `true`, do not attempt to label the PR.
`changelog-host`	The proto://host where commits live. Defaults to `${{ github.server_url }}` (usually `https://github.com`)
`versioning-strategy`	The versioning strategy to use. Defaults to `default`
`release-as`	The version to release as.

GitHub Credentials

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

If your repository is in an organization, you may need to permit github actions to create an approve PRs.

[!WARNING]
If using GitHub Actions, you will need to specify a token for your workflows to run on Release Please's releases and PRs. See the heading below.

Other Actions on Release Please 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.

Workflow Permissions

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

yaml

permissions:
  contents: write
  issues: 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:

GitHub APIs protected by contents permission
GitHub APIs protected by pull_requests permission
Github Actions: permissions for the GITHUB_TOKEN
Github Repositories: enabling workflows for forks of private repositories
Github Actions: assigning permissions to jobs

Release Types Supported

Release Please automates releases for the following flavors of repositories:

release type	description
`dart`	A repository with a pubspec.yaml and a CHANGELOG.md
`elixir`	An elixir repository with a mix.exs and a CHANGELOG.md
`expo`	An Expo based React Native repository, with a package.json, app.json and 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
`krm-blueprint`	A kpt package, with 1 or more KRM files and a CHANGELOG.md
`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