Skip to content

Clear up the automated comment #112

Clear up the automated comment

Clear up the automated comment #112

Workflow file for this run

name: Comment on manual command changes
on:
pull_request_target:
paths:
- 'commands/docs/**'
- 'commands/categories/**'
jobs:
comment:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
with:
script: |
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: 'Awesome that you are trying to improve the documentation of a nushell command!\n\n' +
'You should not modify the files in `commands/docs` or `commands/categores`\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 and can close this PR!\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'+
'- If you accidentally made a change in `commands/` while working on general documentation, please revert changes to `commands/`\n\n'+
'Thanks for helping out!'
})
- run: |
echo "This PR touched autogenerated command docs. If you are not a maintainer of the autogenerated docs, please revert changes to `commands/docs/**` and make the change on the nushell side"
exit 1