command-block.yml

name: Comment on manual command changes
on:
  pull_request:
    paths:
      - 'commands/docs/**'

# Fix Resource not accessible by integration (updatePullRequest)
permissions:
  issues: write
  pull-requests: write

jobs:
  comment:
    runs-on: ubuntu-latest
    # If the docs was updated by hustcer, skip the commenting step
    if: ${{github.event.pull_request.user.login != 'hustcer'}}
    steps:
      - uses: peter-evans/create-or-update-comment@v4
        with:
          issue-number: ${{ github.event.pull_request.number }}
          body: |
            Awesome that you are trying to improve the documentation of a nushell command!

            As we autogenerate these command pages from the help information defined with the command after each release:
            - If you already updated the command help, you are already done!
            - Else, please look for the command in the [source tree](https://github.com/nushell/nushell/tree/main/crates) and make your changes directly there.

            Thanks for helping out!