piaskowyk / pr-description

GitHub Action to update pull request descriptions.

Update Pull Request Description

GitHub action to append or replace text in a pull request description.

Usage

This action supports pull_request and push events (where the push event ocurred on a branch with an open pull request).

Inputs

• content: The content to append or replace in the PR body. Can be raw text or a file path. If a file path is provided, contentIsFilePath must be set to "true".
• contentIsFilePath: Whether the content input is a file path. Defaults to "false".
• regex: The regex to match against the PR body and replace with content. Defaults to "---.*".
• regexFlags: The regex flags to use. Defaults to "".
• appendContentOnMatchOnly: Whether to skip appending the content to the PR body if no regex matches are found. Defaults to "false".
• token: The GitHub token to use.

Note: append mode is the default behavior when no regex match is found for backwards compatibility with existing action users. This may change in future minor/major versions and will be noted in the changelog.

Example Workflows

• Simple replace all text in the PR description with Hello there!:

  on:
      pull_request:
  
  jobs:
      update-pr-description:
          runs-on: ubuntu-latest
          steps:
              - name: Checkout
                uses: actions/checkout@v3
              - name: Update PR Description
                uses: nefrob/pr-description@v1.1.1
                with:
                    content: "Hello there!"
                    regex: ".*"
                    regexFlags: i
                    token: ${{ secrets.GITHUB_TOKEN }}

• Reading from a file:

  on:
      pull_request:
  
  jobs:
      update-pr-description:
          runs-on: ubuntu-latest
          steps:
              - name: Checkout
                uses: actions/checkout@v3
              - name: Update PR Description
                uses: nefrob/pr-description@v1.1.1
                with:
                    content: path/to/file.txt
                    contentIsFilePath: true
                    token: ${{ secrets.GITHUB_TOKEN }}

• Replace text in between comments:

  pull_request_template.md file

  <!-- start regex match -->
  
  Anything in between these comments will be replaced by a push to the PR.
  
  <!-- end regex match -->

  and workflow

  on:
      pull_request:
  
  jobs:
      update-pr-description:
          runs-on: ubuntu-latest
          steps:
              - name: Checkout
                uses: actions/checkout@v3
              - name: Update PR Description
                uses: nefrob/pr-description@v1.1.1
                with:
                    content: "<!-- start regex match -->New content!<!-- end regex match -->"
                    regex: "<!-- start regex match -->.*?<!-- end regex match -->"
                    regexFlags: ims
                    token: ${{ secrets.GITHUB_TOKEN }}