Pull Request Updater

This is a GitHub Action that updates a pull request.

Usage

Create a workflow yaml file (for e.g. .github/workflows/update-pr.yml). See Creating a Workflow file.

Inputs

Required

• token: secret token to allow making calls to GitHub's rest API (for e.g. ${{ secrets.GITHUB_TOKEN }})

Optional

• title: Title replacement for the PR
• title-prefix: Text to be prepended to the PR title
• title-suffix: Text to be appended to the PR title
• body: Body replacement for the PR
• body-prefix: Text to be prepended to the PR body
• body-suffix: Text to be appended to the PR body
• body-concat-new-line: Flag to indicate whether to add a new line between the body prefix and suffix

Outputs

• new-title: New PR title
• new-body: New PR body

Example

name: "Update Pull Request"
on: pull_request

jobs:
  update_pr:
    runs-on: ubuntu-latest
    steps:
    - uses: kognity/pr-update-action
      with:
        token: "${{ secrets.GITHUB_TOKEN }}"
        title-prefix: "[KOG-9999]"
        body-suffix: |
          My multiline body
          Another line

Scaffolding derived from typescript-action