update-pull-request.yml

# This workflow updates the pull request description with an auto-generated section containing the categorised commit
# message headers of the commits since the last pull request merged into main. 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.

name: update-pull-request

# Only trigger for pull requests into main branch.
on:
  pull_request:
    branches:
      - main

jobs:
  description:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          # Set fetch-depth to 0 to fetch all commit history (necessary for compiling pull request description).
          fetch-depth: 0

      - name: Install release note compiler
        run: pip install git+https://github.com/octue/conventional-commits

      - name: Compile new pull request description
        run: |
          echo 'PULL_REQUEST_NOTES<<EOF' >> $GITHUB_ENV
          echo "$(compile-release-notes PULL_REQUEST_START --pull-request-url=${{ github.event.pull_request.url }} --api-token=${{ secrets.GITHUB_TOKEN }})" >> $GITHUB_ENV
          echo EOF >> $GITHUB_ENV

      - name: Update pull request body
        uses: riskledger/update-pr-description@v2
        with:
          body: ${{ env.PULL_REQUEST_NOTES }}
          token: ${{ secrets.GITHUB_TOKEN }}