Skip to content

Commit

Permalink
Command doc lint ignore for autogen maintainer (#1708)
Browse files Browse the repository at this point in the history
* Command doc lint ignore for autogen maintainer

* Check stefan triggering message

* Revert "Check stefan triggering message"

This reverts commit 6b23359.

* Fix/document exemption rule

* Fix the comment
  • Loading branch information
sholderbach authored Dec 22, 2024
1 parent 6de3229 commit 8943a68
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .github/workflows/command-block.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ on:
jobs:
comment:
runs-on: ubuntu-latest
# Maintainers/Contributors can add themselves exempt from this bot if they regularly run the command doc generation.
# If you are on this list, be careful about accidental changes!
if: ${{!contains(fromJSON('["hustcer", "sholderbach"]'), github.event.pull_request.user.login)}}
steps:
- uses: actions/[email protected]
with:
Expand All @@ -17,7 +20,7 @@ jobs:
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/categorees`!\n' +
'**You should not modify the files in `commands/docs` or `commands/categories`!**\n' +
'We autogenerate these command pages from the `help` information defined by the command implementation, after each release. Thus:\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 in the `impl Command` and `Signature`.\n'+
Expand Down

0 comments on commit 8943a68

Please sign in to comment.