release-please-action

Composite GitHub Action which wraps release-please-action and github-app-token actions, with some opinionated default settings.

Features

• Makes it easy to run release-please as a GitHub App, allowing checks to run on Release Pull Requests.
• Defaults to placing release-please config and manifest within the .github folder in the repository root:
  • .github/release-please-manifest.json instead of .release-please-manifest.json.
  • .github/release-please-config.json instead of release-please-config.json.

To-Do

• Verify stability of this action.
• Setup CI releases using itself, so the action can be referred to with @v1 instead of @main.

Examples

The below example assumes you have secrets already setup for the app ID and private key.

If you do not want to authenticate as a GitHub App, simply do not provide app-id and private-key inputs.

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

The above, is equivalent to:

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