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
  contents: read
  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: actions/github-script@v7.0.1
        with:
          script: |
            github.rest.pulls.createReview({
              owner: context.repo.owner,
              repo: context.repo.repo,
              pull_number: context.issue.number,
              body: 'Awesome that you are trying to improve the documentation of a nushell command!\n\n' +
                'As we autogenerate these command pages from the help information defined with the command after each release:\n'+
                '- If you already updated the command help, you are already done!\n'+
                '- Else, please look for the command in the [source tree](https://github.com/nushell/nushell/tree/main/crates) and make your changes directly there.\n\n'+
                'Thanks for helping out!',
              event: 'COMMENT'
            })