rst-pr.yml

name: RST PR
on:
  pull_request_target:
    types: [opened, synchronize, reopened]
    paths:
      - "docs/*.rst"

jobs:
  notify:
    permissions:
      pull-requests: write
    runs-on: ubuntu-latest
    steps:
    - name: Look for an existing comment
      id: fc
      uses: peter-evans/find-comment@v1
      with:
        issue-number: ${{ github.event.number }}
        body-includes: '### Generated Docs Modified'
        comment-author: 'github-actions[bot]'

    - name: Notify the author
      id: comment
      uses: peter-evans/create-or-update-comment@v1
      with:
        comment-id: ${{ steps.fc.outputs.comment-id }}
        issue-number: ${{ github.event.number }}
        edit-mode: replace
        body: |
          ### Generated Docs Modified

          This PR with commit ${{ github.event.pull_request.head.sha }} is directly editing an RST file.
          These files are auto-generated and will be overwritten on release.

          To update documentation, please edit the appropriate `.py` file(s) used to generate the documentation.