From c05591aaf7520464cfe8c4132bcdfbedbe424290 Mon Sep 17 00:00:00 2001 From: sholderbach Date: Mon, 23 Dec 2024 00:31:16 +0100 Subject: [PATCH 1/5] Command doc lint ignore for autogen maintainer --- .github/workflows/command-block.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/command-block.yml b/.github/workflows/command-block.yml index 7874e64dd2d..68d8c263eb9 100644 --- a/.github/workflows/command-block.yml +++ b/.github/workflows/command-block.yml @@ -8,6 +8,7 @@ on: jobs: comment: runs-on: ubuntu-latest + if: ${{!contains(fromJSON('[hustcer]'), github.event.pull_request.user.login)}} steps: - uses: actions/github-script@v7.0.1 with: From 6b2335925ead27ec9dcb8c9adba3a75704b39969 Mon Sep 17 00:00:00 2001 From: sholderbach Date: Mon, 23 Dec 2024 00:33:38 +0100 Subject: [PATCH 2/5] Check stefan triggering message --- commands/docs/alias.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/commands/docs/alias.md b/commands/docs/alias.md index a58b552b7f5..eabc262b82d 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -23,6 +23,7 @@ usage: | - `name`: Name of the alias. - `initial_value`: Equals sign followed by value. +STEFAN TRIGGERING ## Input/output types: @@ -40,4 +41,4 @@ Alias ll to ls -l ## Notes This command is a parser keyword. For details, check: - https://www.nushell.sh/book/thinking_in_nu.html \ No newline at end of file + https://www.nushell.sh/book/thinking_in_nu.html From c79803af0a75495b304a8bd82c4a0c72bee52db0 Mon Sep 17 00:00:00 2001 From: sholderbach Date: Mon, 23 Dec 2024 00:35:40 +0100 Subject: [PATCH 3/5] Revert "Check stefan triggering message" This reverts commit 6b2335925ead27ec9dcb8c9adba3a75704b39969. --- commands/docs/alias.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/commands/docs/alias.md b/commands/docs/alias.md index eabc262b82d..a58b552b7f5 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -23,7 +23,6 @@ usage: | - `name`: Name of the alias. - `initial_value`: Equals sign followed by value. -STEFAN TRIGGERING ## Input/output types: @@ -41,4 +40,4 @@ Alias ll to ls -l ## Notes This command is a parser keyword. For details, check: - https://www.nushell.sh/book/thinking_in_nu.html + https://www.nushell.sh/book/thinking_in_nu.html \ No newline at end of file From 3d8883d9c8df69c4af28ac1d048db048ce94ca37 Mon Sep 17 00:00:00 2001 From: sholderbach Date: Mon, 23 Dec 2024 00:38:27 +0100 Subject: [PATCH 4/5] Fix/document exemption rule --- .github/workflows/command-block.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/command-block.yml b/.github/workflows/command-block.yml index 68d8c263eb9..219bbbac917 100644 --- a/.github/workflows/command-block.yml +++ b/.github/workflows/command-block.yml @@ -8,7 +8,9 @@ on: jobs: comment: runs-on: ubuntu-latest - if: ${{!contains(fromJSON('[hustcer]'), github.event.pull_request.user.login)}} + # 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/github-script@v7.0.1 with: From 5c34bc28ffff152603ec466419ec630a4eba6f3a Mon Sep 17 00:00:00 2001 From: sholderbach Date: Mon, 23 Dec 2024 00:39:32 +0100 Subject: [PATCH 5/5] Fix the comment --- .github/workflows/command-block.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/command-block.yml b/.github/workflows/command-block.yml index 219bbbac917..704f9077090 100644 --- a/.github/workflows/command-block.yml +++ b/.github/workflows/command-block.yml @@ -20,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'+