release-please-manifest-action/README.md

release-please-manifest-action

Opinionated action for running release-please in manifest mode.

A composite action which wraps release-please-action and github-app-token actions, with opinionated defaults.

Features

• Supports having release-please authenticate as a GitHub App.
• Defaults to looking for release-please's config and manifest files within the top-level .github directory instead of in the repository root.

Examples

All examples assume you have placed your release-please-config.json and .release-please-manifest.json within the .github directory in the root of the repository.

See release-please's manifest-releaser documentation for details about the config and manifest files.

Basic (Actions Token)

This example will have release-please authenticate using secrets.GITHUB_TOKEN that is automatically available to all actions.

This will prevent checks / GitHub Actions running against any Release Pull Requests raised by release-please. This is a feature of GitHub as a means of trying to avoid GitHub Actions jobs triggering themselves, causing an endless loop.

If you need checks to run against Release Pull Requests, you will need to have release-please authenticate with a Personal Access Token (PAT), or as a GitHub App.

on: push
jobs:
  release-please:
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main'
    steps:
      - uses: jimeh/release-please-manifest-action@v1

The above is equivalent to:

on: push
jobs:
  release-please:
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main'
    steps:
      - uses: googleapis/release-please-action@v4
        id: release-please
        with:
          config-file: .github/release-please-config.json
          manifest-file: .github/.release-please-manifest.json

Note: Outputs are not included in this equivalence example.

Personal Access Token (PAT) Authentication

This example will have release-please authenticate with a user's Personal Access Token (PAT), performing all operations on behalf of that user. Allowing checks / GitHub Actions to run against Release Pull Requests.

It is common to have a dedicated "bot" user created for these purposes. But within paid organizations, that means an extra user seat needs to be paid for. In that case you might prefer using a GitHub App instead.

on: push
jobs:
  release-please:
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main'
    steps:
      - uses: jimeh/release-please-manifest-action@v1
        with:
          token: ${{ secrets.RELEASE_PAT_TOKEN }}

The above is equivalent to:

on: push
jobs:
  release-please:
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main'
    steps:
      - uses: googleapis/release-please-action@v4
        id: release-please
        with:
          token: ${{ secrets.RELEASE_PAT_TOKEN }}
          config-file: .github/release-please-config.json
          manifest-file: .github/.release-please-manifest.json

Note: Outputs are not included in this equivalence example.

GitHub App Authentication

This example will have release-please authenticate as a GitHub App, performing all operations on behalf of the app.

This has a few benefits compared to using the token provided by GitHub Actions or a user's personal access token:

• It allows checks / GitHub Actions to run against the Release Pull Requests raised by release-please.
• An app can be given permissions to access all repos within an organization.
• Compared to creating a separate "bot" user, paid organizations do not need to pay for an extra user seat when using an app.

Below we assume you have already setup RELEASE_BOT_APP_ID and RELEASE_BOT_PRIVATE_KEY secrets in the repository or organization.

To set the private key secret, it is easiest to base64 encode the contents of the *.pem file you get from the GitHub App's configuration page. The base64 encoded string should not have any line-breaks.

on: push
jobs:
  release-please:
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main'
    steps:
      - uses: jimeh/release-please-manifest-action@v1
        with:
          app-id: ${{ secrets.RELEASE_BOT_APP_ID }}
          private-key: ${{ secrets.RELEASE_BOT_PRIVATE_KEY }}

The above is equivalent to:

on: push
jobs:
  release-please:
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main'
    steps:
      - uses: tibdex/github-app-token@v2
        id: github-app-token
        with:
          app_id: ${{ secrets.RELEASE_BOT_APP_ID }}
          private_key: ${{ secrets.RELEASE_BOT_PRIVATE_KEY }}
      - uses: googleapis/release-please-action@v4
        id: release-please
        with:
          token: ${{ steps.github-app-token.outputs.token }}
          config-file: .github/release-please-config.json
          manifest-file: .github/.release-please-manifest.json

Note: Outputs are not included in this equivalence example.

Reference

Inputs

parameter	description	required	default
token	GitHub token used to authenticate.	false	${{ github.token }}
app-id	ID of the GitHub App to use for authentication. If set, takes precedence over token input.	false
private-key	Private key of the GitHub App (can be Base64 encoded). Required when app-id is provided.	false
installation-retrieval-mode	When using app autentication, the mode used to retrieve the installation for which the token will be requested. For more information, see: https://github.com/tibdex/github-app-token/blob/v2/action.yml	false	repository
installation-retrieval-payload	When using app autentication, the payload used to retrieve the installation. For more information, see: https://github.com/tibdex/github-app-token/blob/v2/action.yml	false	${{ github.repository }}
repositories	When using app autentication, the JSON-stringified array of the full names of the repositories the token should have access to. Defaults to all repositories that the installation can access. See https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#create-an-installation-access-token-for-an-app's repositories.	false
permissions	JSON-stringified permissions granted to the app token. Defaults to all the GitHub app permissions, see: https://docs.github.com/en/rest/apps/apps#create-an-installation-access-token-for-an-app	false
github-api-url	configure github API URL. Default https://api.github.com	false	${{ github.api_url }}
github-graphql-url	configure github GraphQL URL. Default https://api.github.com	false	${{ github.graphql_url }}
target-branch	Branch to open pull release PR against. Defaults to the repository's default branch.	false
config-file	Pat to config file within the project.	false	.github/release-please-config.json
manifest-file	Path to manifest file within the project.	false	.github/.release-please-manifest.json

Outputs

parameter	description
release_created	Whether or not a release was created.
upload_url	Release upload URL.
html_url	Release URL.
tag_name	Release tag name.
version	Version that was released.
major	Major version that was released.
minor	Minor version that was released.
patch	Patch version that was released.
sha	Release SHA.
pr	Pull request number.
path	Path that was released.
releases_created	Whether or not a release was created.
paths_released	Paths that were released.
id	Release ID.
name	Release name.
body	Release body.
draft	Whether or not the release is a draft.
prs_created	Pull request numbers.
pr_number	Pull request number that created the release.
prs	Pull request numbers.
release-please	All outputs from release-please action as a JSON string.

License

CC0 1.0 Universal