Skip to content

Command doc lint ignore for autogen maintainer #1708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 22, 2024
Merged

Command doc lint ignore for autogen maintainer #1708

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c05591a
Command doc lint ignore for autogen maintainer
sholderbach Dec 22, 2024
6b23359
Check stefan triggering message
sholderbach Dec 22, 2024
c79803a
Revert "Check stefan triggering message"
sholderbach Dec 22, 2024
3d8883d
Fix/document exemption rule
sholderbach Dec 22, 2024
5c34bc2
Fix the comment
sholderbach Dec 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/command-block.yml
View file
Open in desktop
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
Loading