auto-pr-desc.yml

# This workflow updates the pull request description with an auto-generated section containing the categorised commit
# message headers of the pull request's commits. The auto generated section is enveloped between two comments:
# "<!--- START AUTOGENERATED NOTES --->" and "<!--- END AUTOGENERATED NOTES --->". Anything outside these in the
# description is left untouched. Auto-generated updates can be skipped for a commit if
# "<!--- SKIP AUTOGENERATED NOTES --->" is added to the pull request description.

name: generate-pull-request-description

on: [pull_request, push]

jobs:
  update:
    if: ${{ !contains(github.event.pull_request.body, '<!--- SKIP AUTOGENERATED NOTES --->') }}
    runs-on: ubuntu-latest
    steps:
      # Step 1: Use an action to generate the pull request description
      - name: Generate PR Description
        uses: octue/generate-pull-request-description@main
        id: pr-description
        with:
          pull_request_url: ${{ github.event.pull_request.url }}
          api_token: ${{ secrets.GITHUB_TOKEN }}

      # Step 2: Update the pull request body using the generated description
      - name: Update pull request body
        uses: riskledger/update-pr-description@v2
        with:
          body: ${{ steps.pr-description.outputs.pull_request_description }}
          token: ${{ secrets.GITHUB_TOKEN }}