This action adds to Pull Request descriptions using markdown. It checks if the message is already present before adding.

add_markdown: The message to add to pull requests

github_token: Usually ${{ secrets.GITHUB_TOKEN }}, but a personal access token can also be used

Pull requests from forks have reduced job running rights. Provide your GITHUB_TOKEN with explicit permissions to change that. Read more here.

    permissions:
      pull-requests: write

Create or modify a GitHub workflow, like below. E.g. ./github/workflows/pr-append.yml

name: "Add to Pull Request Description"
on:
  pull_request: [opened]

jobs:
  test:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
    steps:
      - uses: DerekRoberts/action-pr-description-add@v0.0.2
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          add_markdown: |
            ---

            # Things!
            ## Excitement!
            [Links!](https://google.ca)
            `Markdown!`

This Action is provided courtesty of the Forestry Suite of Applications, part of the Government of British Columbia.