mirror of
https://github.com/joaquinjsb/gitea-release-please-action
synced 2026-05-12 21:41:39 +02:00
feat!: v4 release (#871)
Any advanced configuration should be done via a release-please-config.json. Fixes #859 Fixes #858 Fixes #857 Fixes #852 feat!: remove most configuration options in favor of manifest configuration to configure the release-please-action refactor!: rewrite in typescript feat!: remove command option in favor of setting `release-type` and `skip-github-release`/`skip-github-pull-request` feat!: run on node20 deps!: upgrade release-please to v16
This commit is contained in:
Jeff Ching
GitHub
430
README.md
430
README.md
@@ -4,99 +4,86 @@
|
||||
|
||||
Automate releases with Conventional Commit Messages.
|
||||
|
||||
## Setting up this action
|
||||
## Basic Configuration
|
||||
|
||||
1. If you haven't already done so, create a `.github/workflows` folder in your
|
||||
repository (_this is where your actions will live_).
|
||||
2. Now create a `.github/workflows/release-please.yml` file with these contents:
|
||||
1. Create a `.github/workflows/release-please.yml` file with these contents:
|
||||
|
||||
```yaml
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
```yaml
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
|
||||
name: release-please
|
||||
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>
|
||||
```
|
||||
jobs:
|
||||
release-please:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- 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
|
||||
```
|
||||
|
||||
3. Merge the above action into your repository and make sure new commits follow
|
||||
the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
|
||||
convention, [release-please](https://github.com/googleapis/release-please)
|
||||
will start creating Release PRs for you.
|
||||
4. For an alternative configuration that provides easier bootstrapping options
|
||||
for initial setup, follow [these instructions](https://github.com/googleapis/release-please/blob/master/docs/manifest-releaser.md)
|
||||
(ignore the cli section) and then configure this action as follows:
|
||||
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](#advanced-release-configuration)
|
||||
|
||||
```yaml
|
||||
#...(same as above)
|
||||
steps:
|
||||
- uses: google-github-actions/release-please-action@v3
|
||||
with:
|
||||
command: manifest
|
||||
```
|
||||
2. Merge the above action into your repository and make sure new commits follow
|
||||
the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
|
||||
convention, [release-please](https://github.com/googleapis/release-please)
|
||||
will start creating Release PRs for you.
|
||||
|
||||
## Configuration
|
||||
## Advanced Release 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](#release-types-supported); new types of releases can be [added here](https://github.com/googleapis/release-please/tree/main/src/strategies) |
|
||||
| `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](https://github.com/googleapis/release-please/blob/main/docs/customizing.md#updating-arbitrary-files) |
|
||||
| `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`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff) 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](https://github.com/googleapis/release-please/blob/main/docs/customizing.md#changelog-types). 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](https://github.com/googleapis/release-please/blob/main/docs/customizing.md#versioning-strategies). 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 |
|
||||
For any advanced configuration, please set up a
|
||||
[manifest config](https://github.com/googleapis/release-please/blob/master/docs/manifest-releaser.md)
|
||||
and then configure this action as follows:
|
||||
|
||||
## GitHub credentials
|
||||
```yaml
|
||||
#...(same as above)
|
||||
steps:
|
||||
- uses: google-github-actions/release-please-action@v3
|
||||
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](#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`) |
|
||||
| `proxy-server` | Configure a proxy servier 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. |
|
||||
|
||||
## GitHub Credentials
|
||||
|
||||
`release-please` requires a GitHub token to access the GitHub API. You configure this token via
|
||||
the `token` configuration option.
|
||||
@@ -118,17 +105,9 @@ From GitHub's
|
||||
[Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-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](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases)) 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](#how-release-please-works). This pull request, once merged, is used by `github-release`/`manifest`
|
||||
- `manifest`: use [source controlled files](https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md#manifest-driven-release-please) 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:
|
||||
This workflow will need the following permissions in your workflow file:
|
||||
|
||||
```yml
|
||||
permissions:
|
||||
@@ -139,50 +118,81 @@ permissions:
|
||||
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:
|
||||
For more information about permissions:
|
||||
|
||||
- github apis [protected by `contents` permission](https://docs.github.com/en/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#contents)
|
||||
- github apis [protected by `pull_requests` permission](https://docs.github.com/en/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#pull-requests)
|
||||
- GitHub APIs [protected by `contents` permission](https://docs.github.com/en/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#contents)
|
||||
- GitHub APIs [protected by `pull_requests` permission](https://docs.github.com/en/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#pull-requests)
|
||||
- https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token
|
||||
- https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks
|
||||
- https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs
|
||||
|
||||
### Release types supported
|
||||
### 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](https://github.com/googleapis/release-please/blob/main/docs/java.md) |
|
||||
| `maven` | [Strategy for Maven projects, generates SNAPSHOT version after each release and updates `pom.xml` automatically](https://github.com/googleapis/release-please/blob/main/docs/java.md) |
|
||||
| `node` | [A Node.js repository, with a package.json and CHANGELOG.md](https://github.com/yargs/yargs) |
|
||||
| `ocaml` | [An OCaml repository, containing 1 or more opam or esy files and a CHANGELOG.md](https://github.com/grain-lang/binaryen.ml) |
|
||||
| `python` | [A Python repository, with a setup.py, setup.cfg, version.py and CHANGELOG.md](https://github.com/googleapis/python-storage) and optionally a pyproject.toml and a <project>/\_\_init\_\_.py |
|
||||
| `php` | [A php composer package with composer.json and CHANGELOG.md](https://github.com/setnemo/asterisk-notation)
|
||||
| `ruby` | [A Ruby repository, with version.rb and CHANGELOG.md](https://github.com/google/google-id-token) |
|
||||
| `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](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm) and a CHANGELOG.md |
|
||||
| `simple` | [A repository with a version.txt and a CHANGELOG.md](https://github.com/googleapis/gapic-generator) |
|
||||
| `terraform-module` | [A terraform module, with a version in the README.md, and a CHANGELOG.md](https://github.com/terraform-google-modules/terraform-google-project-factory) |
|
||||
| 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](https://github.com/googleapis/release-please/blob/main/docs/java.md) |
|
||||
| `maven` | [Strategy for Maven projects, generates SNAPSHOT version after each release and updates `pom.xml` automatically](https://github.com/googleapis/release-please/blob/main/docs/java.md) |
|
||||
| `node` | [A Node.js repository, with a package.json and CHANGELOG.md](https://github.com/yargs/yargs) |
|
||||
| `ocaml` | [An OCaml repository, containing 1 or more opam or esy files and a CHANGELOG.md](https://github.com/grain-lang/binaryen.ml) |
|
||||
| `python` | [A Python repository, with a setup.py, setup.cfg, version.py and CHANGELOG.md](https://github.com/googleapis/python-storage) and optionally a pyproject.toml and a <project>/\_\_init\_\_.py |
|
||||
| `php` | [A php composer package with composer.json and CHANGELOG.md](https://github.com/setnemo/asterisk-notation) |
|
||||
| `ruby` | [A Ruby repository, with version.rb and CHANGELOG.md](https://github.com/google/google-id-token) |
|
||||
| `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](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm) and a CHANGELOG.md |
|
||||
| `simple` | [A repository with a version.txt and a CHANGELOG.md](https://github.com/googleapis/gapic-generator) |
|
||||
| `terraform-module` | [A terraform module, with a version in the README.md, and a CHANGELOG.md](https://github.com/terraform-google-modules/terraform-google-project-factory) |
|
||||
|
||||
New types of releases can be [added here](https://github.com/googleapis/release-please/tree/main/src/strategies).
|
||||
|
||||
## 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**](https://developer.github.com/v3/repos/releases/#response-4) API |
|
||||
| `html_url` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API |
|
||||
| `tag_name` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) 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](https://github.com/googleapis/release-please/blob/main/src/pull-request.ts#L15) (undefined if no release created) |
|
||||
| `prs` | The JSON string of the array of [PullRequest objects](https://github.com/googleapis/release-please/blob/main/src/pull-request.ts#L15) (undefined if no release created) |
|
||||
| output | description |
|
||||
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `releases_created` | `true` if any release was created, `false` otherwise |
|
||||
| `paths_released` | A JSON string of the array of paths that had releases created (`[]` if ) |
|
||||
| `prs_created` | `true` if any pull request was created or updated |
|
||||
| `pr` | A JSON string of the [PullRequest object](https://github.com/googleapis/release-please/blob/main/src/pull-request.ts#L15) (unset if no release created) |
|
||||
| `prs` | A JSON string of the array of [PullRequest objects](https://github.com/googleapis/release-please/blob/main/src/pull-request.ts#L15) (unset if no release created) |
|
||||
|
||||
### Root component outputs
|
||||
|
||||
If you have a root component (path is `.` or unset), then the action will also output:
|
||||
|
||||
| output | description |
|
||||
| -------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `release_created` | `true` if the release was created, `false` otherwise |
|
||||
| `release_upload_url` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API |
|
||||
| `release_html_url` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API |
|
||||
| `release_tag_name` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API |
|
||||
| `release_major` | Number representing major semver value |
|
||||
| `release_minor` | Number representing minor semver value |
|
||||
| `release_patch` | Number representing patch semver value |
|
||||
| `release_sha` | SHA that a GitHub release was tagged at |
|
||||
|
||||
### Path outputs
|
||||
|
||||
If you have a monorepo or a component with `path` different than the root (`.`)
|
||||
directory, then your outputs will have the `path` prefixed to the output name.
|
||||
|
||||
This prefix allows you to distinguish values for different releases.
|
||||
|
||||
| output | description |
|
||||
| ------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `<path>--release_created` | `true` if the release was created, `false` otherwise |
|
||||
| `<path>--upload_url` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API |
|
||||
| `<path>--html_url` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API |
|
||||
| `<path>--tag_name` | Directly related to [**Create a release**](https://developer.github.com/v3/repos/releases/#response-4) API |
|
||||
| `<path>--major` | Number representing major semver value |
|
||||
| `<path>--minor` | Number representing minor semver value |
|
||||
| `<path>--patch` | Number representing patch semver value |
|
||||
| `<path>--sha` | sha that a GitHub release was tagged at |
|
||||
|
||||
## How release please works
|
||||
|
||||
@@ -207,71 +217,36 @@ Release Please assumes you are using [Conventional Commit messages](https://www.
|
||||
|
||||
The most important prefixes you should have in mind are:
|
||||
|
||||
* `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/)
|
||||
- `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/)
|
||||
patch.
|
||||
* `feat:` which represents a new feature, and correlates to a SemVer minor.
|
||||
* `feat!:`, or `fix!:`, `refactor!:`, etc., which represent a breaking change
|
||||
- `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:
|
||||
|
||||
```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
|
||||
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`):
|
||||
|
||||
```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`):
|
||||
```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
|
||||
- uses: google-github-actions/release-please-action@v4
|
||||
with:
|
||||
release-type: node
|
||||
package-name: release-please-action
|
||||
default-branch: 1.x
|
||||
# The short ref name of the branch or tag that triggered
|
||||
# the workflow run. For example, `main` or `1.x`
|
||||
default-branch: ${{ github.ref_name }}
|
||||
```
|
||||
|
||||
## Automating publication to npm
|
||||
@@ -289,11 +264,10 @@ jobs:
|
||||
release-please:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: google-github-actions/release-please-action@v3
|
||||
- uses: google-github-actions/release-please-action@v4
|
||||
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
|
||||
@@ -313,7 +287,7 @@ jobs:
|
||||
```
|
||||
|
||||
> So that you can keep 2FA enabled for npm publications, we recommend setting
|
||||
`registry-url` to your own [Wombat Dressing Room](https://github.com/GoogleCloudPlatform/wombat-dressing-room) deployment.
|
||||
> `registry-url` to your own [Wombat Dressing Room](https://github.com/GoogleCloudPlatform/wombat-dressing-room) deployment.
|
||||
|
||||
## Creating major/minor tags
|
||||
|
||||
@@ -337,12 +311,11 @@ jobs:
|
||||
release-please:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: google-github-actions/release-please-action@v3
|
||||
- uses: google-github-actions/release-please-action@v4
|
||||
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 }}
|
||||
@@ -360,57 +333,6 @@ jobs:
|
||||
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.
|
||||
|
||||
```yaml
|
||||
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](https://github.com/googleapis/release-please/blob/main/docs/customizing.md#updating-arbitrary-files) for more info on how release-please will update those files.
|
||||
|
||||
```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
|
||||
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.
|
||||
@@ -427,7 +349,7 @@ jobs:
|
||||
release-please:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: google-github-actions/release-please-action@v3
|
||||
- uses: google-github-actions/release-please-action@v4
|
||||
id: release
|
||||
with:
|
||||
release-type: node
|
||||
@@ -435,10 +357,66 @@ jobs:
|
||||
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
|
||||
run: gh release upload ${{ steps.release.outputs.tag_name }} ./artifact/some-build-artifact.zip
|
||||
```
|
||||
|
||||
## Upgrading from v3 to v4
|
||||
|
||||
### Command
|
||||
|
||||
If you were setting the `command` option, you will likely need to modify your configuration.
|
||||
|
||||
| Command | New Configuration | Description |
|
||||
| ---------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `github-release` | `skip-github-pull-request: true` | This command was used for only tagging releases. Now we tell relese-please to skip opening release PRs. |
|
||||
| `release-pr` | `skip-github-release: true` | This command was used for only opening release PRs. Now we tell release-please to skip tagging releases. |
|
||||
| `manifest` | do not set `release-type` option | This command told release-please to use a manifest config file. This is now the default behavior unless you explicitly set a `release-type`. |
|
||||
| `manifest-pr` | `skip-github-release: true` and do not set `release-type` option | This command told release-please to use a manifest config file and only open the pull reuqest. |
|
||||
|
||||
### Package options
|
||||
|
||||
If you were previously configuring advanced options via GitHub action inputs, you
|
||||
will need to configure via the release-please manifest configuration instead. Below,
|
||||
you can see a mapping of the old option to the new option:
|
||||
|
||||
| Old Option | New Option | Notes |
|
||||
| ---------------------------------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `path` | `$.packages` | The root `packages` field is an object where the key is the `path` being configured |
|
||||
| `changelog-path` | `$.packages[path].changelog-path` | Package-only option |
|
||||
| `component` | `$.packages[path].component` | Package-only option |
|
||||
| `package-name` | `$.packages[path].package-name` | Package-only option |
|
||||
| `always-link-local` | `$.always-link-loca` | Root-only option |
|
||||
| `bootstrap-sha` | `$.bootstrap-sha` | Root-only option |
|
||||
| `commit-search-depth` | `$.commit-search-depth` | Root-only option |
|
||||
| `group-pull-request-title-pattern` | `$.group-pull-request-title-pattern` | Root-only option |
|
||||
| `last-release-sha` | `$.last-release-sha` | Root-only option |
|
||||
| `plugins` | `$.plugins` | Root-only option |
|
||||
| `release-search-depth` | `$.release-search-depth` | Root-only option |
|
||||
| `sequential-calls` | `$.sequential-calls` | Root-only option |
|
||||
| `skip-labeling` | `$.skip-labeling` | Root-only option |
|
||||
| `signoff` | `$.signoff` | Root-only option |
|
||||
| `bump-minor-pre-major` | `$.bump-minor-pre-major` or `$.packages[path].bump-minor-pre-major` | Root or per-package option |
|
||||
| `bump-patch-for-minor-pre-major` | `$.bump-path-for-minor-pre-major` or `$.packages[path].bump-path-for-minor-pre-major` | Root or per-package option |
|
||||
| `changelog-host` | `$.changelog-host` or `$.packages[path].changelog-host` | Root or per-package option |
|
||||
| `changelog-notes-type` | `$.changelog-type` or `$.packages[path].changelog-type` | Root or per-package option |
|
||||
| `changelog-types` | `$.changelog-sections` or `$.packages[path].changelog-sections` | Root or per-package option |
|
||||
| `extra-files` | `$.extra-files` or `$.packages[path].extra-files` | Root or per-package option |
|
||||
| `include-v-in-tag` | `$.include-v-in-tag` or `$.packages[path].include-v-in-tag` | Root or per-package option |
|
||||
| `labels` | `$.label` or `$.packages[path].label` | Root or per-package option |
|
||||
| `monorepo-tags` | `$.include-component-in-tag` or `$.packages[path].include-component-in-tag` | Root or per-package option |
|
||||
| `prerelease` | `$.prerelease` or `$.packages[path].prerelease` | Root or per-package option |
|
||||
| `pull-request-header` | `$.pull-request-header` or `$.packages[path].pull-request-header` | Root or per-package option |
|
||||
| `pull-request-title-pattern` | `$.pull-request-title-pattern` or `$.packages[path].pull-request-title-pattern` | Root or per-package option |
|
||||
| `release-as` | `$.release-as` or `$.packages[path].release-as` | Root or per-package option |
|
||||
| `release-labels` | `$.release-label` or `$.packages[path].release-label` | Root or per-package option |
|
||||
| `release-type` | `$.release-type` or `$.packages[path].release-type` | Root or per-package option |
|
||||
| `separate-pull-requests` | `$.separate-pull-requests` or `$.packages[path].separate-pull-requests` | Root or per-package option |
|
||||
| `skip-github-release` | `$.skip-github-release` or `$.packages[path].skip-github-release` | Root or per-package option |
|
||||
| `snapshot-labels` | `$.snapshot-label` or `$.packages[path].snapshot-label` | Root or per-package option |
|
||||
| `tag-separator` | `$.tag-separator` or `$.packages[path].tag-separator` | Root or per-package option |
|
||||
| `version-file` | `$.version-file` or `$.packages[path].version-file` | Root or per-package option |
|
||||
| `versioning-strategy` | `$.versioning` or `$.packages[path].versioning` | Root or per-package option |
|
||||
|
||||
## License
|
||||
|
||||
Apache Version 2.0
|
||||
|
||||
Reference in New Issue
Block a user