release-note-changes.yml

name: Release note changes

on:
  pull_request:
    branches:
      - 'main'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4.1.1
        with:
          fetch-depth: 0

      - name: Create output file
        run: touch changelog_comment.md

      - name: Get changed changelog files
        id: changed-files
        uses: tj-actions/changed-files@v41.0.0
        with:
          files_ignore: |
            plugins/**
          files: |
            **/CHANGELOG.md

      - name: Set up JDK 17
        uses: actions/setup-java@v4.1.0
        with:
          java-version: 17
          distribution: temurin
          cache: gradle

      - name: Set up Python 3.10
        uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3
        if: ${{ steps.changed-files.outputs.any_changed == 'true' }}
        with:
          python-version: '3.10'

      - name: Set up fireci
        id: install-fireci
        if: ${{ steps.changed-files.outputs.any_changed == 'true' }}
        run: pip3 install -e ci/fireci

      - name: Generate comment
        id: generate-comment
        if: ${{ steps.install-fireci.outcome == 'success' }}
        run: |
          fireci changelog_comment -c "${{ steps.changed-files.outputs.all_changed_files }}" -o ./changelog_comment.md

      - name: Add PR Comment
        uses: mshick/add-pr-comment@v2.8.1
        continue-on-error: true
        with:
          status: ${{ steps.generate-comment.outcome }}
          message-path: ./changelog_comment.md
          message-skipped: |
            ## Release note changes
            No release note changes were detected. If you made changes that should be
            present in the next release, ensure you've added an entry in the appropriate
            `CHANGELOG.md` file(s).
          message-failure: |
            ## Release note changes
            A `CHANGELOG.md` file seems to not match the expected format.
            Please ensure your changelog files are following the format as
            defined in [our documentation](#).