From f2cd50e1e269c9f4fd117926c8814fb9a7218f4d Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 09:15:22 +0100 Subject: [PATCH 01/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Update=20script?= =?UTF-8?q?=20path=20format=20in=20TestWorkflow.yml?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/TestWorkflow.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/TestWorkflow.yml b/.github/workflows/TestWorkflow.yml index f2310a1..5fefcee 100644 --- a/.github/workflows/TestWorkflow.yml +++ b/.github/workflows/TestWorkflow.yml @@ -60,7 +60,7 @@ jobs: with: Debug: true Verbose: true - Script: . '.\tests\info.ps1' + Script: .\tests\info.ps1 ActionTestCommands: name: Commands + Outputs From ebd9051f2d4899f1117826b1dcd7a486b6e240dc Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 09:29:36 +0100 Subject: [PATCH 02/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20additiona?= =?UTF-8?q?l=20action=20test=20with=20debug=20and=20verbose=20options=20in?= =?UTF-8?q?=20TestWorkflow.yml?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/TestWorkflow.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/workflows/TestWorkflow.yml b/.github/workflows/TestWorkflow.yml index 5fefcee..5a302f2 100644 --- a/.github/workflows/TestWorkflow.yml +++ b/.github/workflows/TestWorkflow.yml @@ -62,6 +62,14 @@ jobs: Verbose: true Script: .\tests\info.ps1 + + - name: Action-Test 2 + uses: ./ + with: + Debug: true + Verbose: true + Script: . '.\tests\info.ps1' + ActionTestCommands: name: Commands + Outputs runs-on: ${{ inputs.runs-on }} From b51f7d6e8fff4cf191edc447374e106c524a3801 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 09:40:31 +0100 Subject: [PATCH 03/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Update=20Action?= =?UTF-8?q?-Test=20names=20and=20script=20paths=20in=20TestWorkflow.yml=20?= =?UTF-8?q?and=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/TestWorkflow.yml | 18 ++++++++++++++++-- README.md | 2 +- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/.github/workflows/TestWorkflow.yml b/.github/workflows/TestWorkflow.yml index 5a302f2..5764d05 100644 --- a/.github/workflows/TestWorkflow.yml +++ b/.github/workflows/TestWorkflow.yml @@ -55,21 +55,35 @@ jobs: - name: Checkout repo uses: actions/checkout@v4 - - name: Action-Test + - name: Action-Test [.\tests\info.ps1] uses: ./ with: Debug: true Verbose: true Script: .\tests\info.ps1 + - name: Action-Test 2 [tests\info.ps1] + uses: ./ + with: + Debug: true + Verbose: true + Script: tests\info.ps1 - - name: Action-Test 2 + - name: Action-Test 3 [tests/info.ps1] + uses: ./ + with: + Debug: true + Verbose: true + Script: tests/info.ps1 + + - name: Action-Test 4 [. '.\tests\info.ps1'] uses: ./ with: Debug: true Verbose: true Script: . '.\tests\info.ps1' + ActionTestCommands: name: Commands + Outputs runs-on: ${{ inputs.runs-on }} diff --git a/README.md b/README.md index a6a7a9e..536fd57 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ jobs: - name: Run script uses: PSModule/GitHub-Script@v1 with: - Script: "scripts/main.ps1" + Script: scripts/main.ps1 ``` #### Example 2: Run a GitHub PowerShell script without a token From c4c4c785845978eb5c23bf0abd681bde155e9395 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 09:40:40 +0100 Subject: [PATCH 04/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Remove=20unnece?= =?UTF-8?q?ssary=20blank=20line=20in=20TestWorkflow.yml?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/TestWorkflow.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/TestWorkflow.yml b/.github/workflows/TestWorkflow.yml index 5764d05..4c24362 100644 --- a/.github/workflows/TestWorkflow.yml +++ b/.github/workflows/TestWorkflow.yml @@ -83,7 +83,6 @@ jobs: Verbose: true Script: . '.\tests\info.ps1' - ActionTestCommands: name: Commands + Outputs runs-on: ${{ inputs.runs-on }} From c15f322792848f6b24183f2d6cd966a1c9888f7d Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 09:43:06 +0100 Subject: [PATCH 05/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20condition?= =?UTF-8?q?al=20execution=20for=20Action-Test=20steps=20in=20TestWorkflow.?= =?UTF-8?q?yml?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/TestWorkflow.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/TestWorkflow.yml b/.github/workflows/TestWorkflow.yml index 4c24362..eed3207 100644 --- a/.github/workflows/TestWorkflow.yml +++ b/.github/workflows/TestWorkflow.yml @@ -56,6 +56,7 @@ jobs: uses: actions/checkout@v4 - name: Action-Test [.\tests\info.ps1] + if: success() || failure() uses: ./ with: Debug: true @@ -63,6 +64,7 @@ jobs: Script: .\tests\info.ps1 - name: Action-Test 2 [tests\info.ps1] + if: success() || failure() uses: ./ with: Debug: true @@ -70,6 +72,7 @@ jobs: Script: tests\info.ps1 - name: Action-Test 3 [tests/info.ps1] + if: success() || failure() uses: ./ with: Debug: true @@ -77,6 +80,7 @@ jobs: Script: tests/info.ps1 - name: Action-Test 4 [. '.\tests\info.ps1'] + if: success() || failure() uses: ./ with: Debug: true From 2097857b566c1595a67ac9a7db91c04161c0a111 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 09:47:24 +0100 Subject: [PATCH 06/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Standardize=20s?= =?UTF-8?q?cript=20path=20format=20and=20add=20additional=20Action-Test=20?= =?UTF-8?q?entries=20in=20TestWorkflow.yml?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/TestWorkflow.yml | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/.github/workflows/TestWorkflow.yml b/.github/workflows/TestWorkflow.yml index eed3207..8478f35 100644 --- a/.github/workflows/TestWorkflow.yml +++ b/.github/workflows/TestWorkflow.yml @@ -55,37 +55,50 @@ jobs: - name: Checkout repo uses: actions/checkout@v4 - - name: Action-Test [.\tests\info.ps1] + - name: Action-Test [tests\info.ps1] if: success() || failure() uses: ./ with: Debug: true Verbose: true - Script: .\tests\info.ps1 - - - name: Action-Test 2 [tests\info.ps1] + Script: tests\info.ps1 + - name: Action-Test [tests/info.ps1] if: success() || failure() uses: ./ with: Debug: true Verbose: true - Script: tests\info.ps1 + Script: tests/info.ps1 - - name: Action-Test 3 [tests/info.ps1] + - name: Action-Test [.\tests\info.ps1] if: success() || failure() uses: ./ with: Debug: true Verbose: true - Script: tests/info.ps1 + Script: .\tests\info.ps1 + - name: Action-Test [./tests/info.ps1] + if: success() || failure() + uses: ./ + with: + Debug: true + Verbose: true + Script: ./tests/info.ps1 - - name: Action-Test 4 [. '.\tests\info.ps1'] + - name: Action-Test [. '.\tests\info.ps1'] if: success() || failure() uses: ./ with: Debug: true Verbose: true Script: . '.\tests\info.ps1' + - name: Action-Test [. './tests/info.ps1'] + if: success() || failure() + uses: ./ + with: + Debug: true + Verbose: true + Script: . './tests/info.ps1' ActionTestCommands: name: Commands + Outputs From 117d0fb455460a711b70744fc61eeb7d75570e2b Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 10:00:27 +0100 Subject: [PATCH 07/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Comment=20out?= =?UTF-8?q?=20unsupported=20Action-Test=20syntax=20and=20standardize=20scr?= =?UTF-8?q?ipt=20path=20format=20in=20TestWorkflow.yml?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/TestWorkflow.yml | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/.github/workflows/TestWorkflow.yml b/.github/workflows/TestWorkflow.yml index 8478f35..337e45a 100644 --- a/.github/workflows/TestWorkflow.yml +++ b/.github/workflows/TestWorkflow.yml @@ -55,13 +55,17 @@ jobs: - name: Checkout repo uses: actions/checkout@v4 - - name: Action-Test [tests\info.ps1] - if: success() || failure() - uses: ./ - with: - Debug: true - Verbose: true - Script: tests\info.ps1 + # # Not a supported way of running the action + # # This syntax is specifically for using a function in a specific module + # # i.e.: moduleName\functionName + # - name: Action-Test [tests\info.ps1] + # if: success() || failure() + # uses: ./ + # with: + # Debug: true + # Verbose: true + # Script: tests\info.ps1 + - name: Action-Test [tests/info.ps1] if: success() || failure() uses: ./ @@ -77,6 +81,7 @@ jobs: Debug: true Verbose: true Script: .\tests\info.ps1 + - name: Action-Test [./tests/info.ps1] if: success() || failure() uses: ./ @@ -92,6 +97,7 @@ jobs: Debug: true Verbose: true Script: . '.\tests\info.ps1' + - name: Action-Test [. './tests/info.ps1'] if: success() || failure() uses: ./ From 29939f06ecce657776e8ee3eae94e4c4fd1cfc65 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 10:01:50 +0100 Subject: [PATCH 08/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Rename=20log=20?= =?UTF-8?q?groups=20in=20info.ps1=20for=20clarity=20and=20consistency?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- tests/info.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/info.ps1 b/tests/info.ps1 index 0bff623..450176b 100644 --- a/tests/info.ps1 +++ b/tests/info.ps1 @@ -1,9 +1,9 @@ #Requires -Modules GitHub -LogGroup ' - Event Info' { +LogGroup ' - Get-GithubEventData' { Get-GithubEventData | Format-List } -LogGroup ' - Runner Info' { +LogGroup ' - Get-GithubRunnerData' { Get-GithubRunnerData | Format-List } From 6dccd436479461ceb957b1f15b708aa254f53252 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 10:23:17 +0100 Subject: [PATCH 09/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20additiona?= =?UTF-8?q?l=20Action-Test=20script=20formats=20in=20TestWorkflow.yml=20an?= =?UTF-8?q?d=20update=20README.md=20with=20supported=20script=20formats?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/TestWorkflow.yml | 24 ++++++++++++------------ README.md | 17 +++++++++++++++++ 2 files changed, 29 insertions(+), 12 deletions(-) diff --git a/.github/workflows/TestWorkflow.yml b/.github/workflows/TestWorkflow.yml index 337e45a..973e194 100644 --- a/.github/workflows/TestWorkflow.yml +++ b/.github/workflows/TestWorkflow.yml @@ -62,48 +62,48 @@ jobs: # if: success() || failure() # uses: ./ # with: - # Debug: true - # Verbose: true # Script: tests\info.ps1 - name: Action-Test [tests/info.ps1] if: success() || failure() uses: ./ with: - Debug: true - Verbose: true Script: tests/info.ps1 - name: Action-Test [.\tests\info.ps1] if: success() || failure() uses: ./ with: - Debug: true - Verbose: true Script: .\tests\info.ps1 - name: Action-Test [./tests/info.ps1] if: success() || failure() uses: ./ with: - Debug: true - Verbose: true Script: ./tests/info.ps1 + - name: Action-Test [. .\tests\info.ps1] + if: success() || failure() + uses: ./ + with: + Script: . .\tests\info.ps1 + + - name: Action-Test [. ./tests/info.ps1] + if: success() || failure() + uses: ./ + with: + Script: . ./tests/info.ps1 + - name: Action-Test [. '.\tests\info.ps1'] if: success() || failure() uses: ./ with: - Debug: true - Verbose: true Script: . '.\tests\info.ps1' - name: Action-Test [. './tests/info.ps1'] if: success() || failure() uses: ./ with: - Debug: true - Verbose: true Script: . './tests/info.ps1' ActionTestCommands: diff --git a/README.md b/README.md index 536fd57..ecadd2c 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,23 @@ jobs: Script: scripts/main.ps1 ``` +The `Script` supports the following formats: + +- Inline script, although it is recommended to use a script file for better tooling support and linting capabilities. +- Multi-line script. +- Path to a script file. + - `tests/info.ps1` + - `.\tests\info.ps1` + - `./tests/info.ps1` + - `. .\tests\info.ps1` + - `. ./tests/info.ps1` + +If you are creation an action of your own, you should use the `${{ github.action_path }}` variable to get the path to the action. +You should avoid using `$env:GITHUB_ACTION_PATH` as it will not be the expected value if you nest actions inside one another. + +> [!WARNING] +> Using `tests\info.ps1` is PowerShells syntax for calling a function under a specific module. + #### Example 2: Run a GitHub PowerShell script without a token Run a script that uses the GitHub PowerShell module. From e7420da1d368ba43cc503bd4703fe077486c59c6 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 11:07:08 +0100 Subject: [PATCH 10/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Update=20README?= =?UTF-8?q?.md=20to=20include=20additional=20script=20formats=20for=20Acti?= =?UTF-8?q?on-Test?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ecadd2c..7733f0b 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,8 @@ The `Script` supports the following formats: - `./tests/info.ps1` - `. .\tests\info.ps1` - `. ./tests/info.ps1` + - `. '.\tests\info.ps1'` + - `. './tests/info.ps1'` If you are creation an action of your own, you should use the `${{ github.action_path }}` variable to get the path to the action. You should avoid using `$env:GITHUB_ACTION_PATH` as it will not be the expected value if you nest actions inside one another. From 15894dae946b37388e4ac3dc9bab49ac7879f8ac Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 11:13:44 +0100 Subject: [PATCH 11/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Update=20README?= =?UTF-8?q?.md=20to=20clarify=20script=20path=20usage=20and=20emphasize=20?= =?UTF-8?q?the=20importance=20of=20using=20the=20correct=20action=20path?= =?UTF-8?q?=20variable?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7733f0b..ef05ef5 100644 --- a/README.md +++ b/README.md @@ -82,8 +82,10 @@ The `Script` supports the following formats: - `. '.\tests\info.ps1'` - `. './tests/info.ps1'` -If you are creation an action of your own, you should use the `${{ github.action_path }}` variable to get the path to the action. -You should avoid using `$env:GITHUB_ACTION_PATH` as it will not be the expected value if you nest actions inside one another. +> [!IMPORTANT] +> Use `${{ github.action_path }}/` if you are creation an action of your own using this action as a step. This will ensure that +> the path to the script is from the calling action, and not the `GitHub-Script` action repo. Using `$env:GITHUB_ACTION_PATH` may have mixed results +> when you nest actions inside one another. The context syntax will be expanded to the correct path at runtime. > [!WARNING] > Using `tests\info.ps1` is PowerShells syntax for calling a function under a specific module. From ec9a97a295a938094a9b5f8226a9e6ac614af5da Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 11:14:35 +0100 Subject: [PATCH 12/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Clarify=20Power?= =?UTF-8?q?Shell=20syntax=20usage=20in=20README.md=20for=20calling=20funct?= =?UTF-8?q?ions=20under=20specific=20modules?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ef05ef5..7affd0a 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ The `Script` supports the following formats: > when you nest actions inside one another. The context syntax will be expanded to the correct path at runtime. > [!WARNING] -> Using `tests\info.ps1` is PowerShells syntax for calling a function under a specific module. +> Using `tests\info.ps1` is PowerShell syntax for calling a function under a specific module, i.e. `Microsoft.PowerShell.Management\Get-ChildItem`. #### Example 2: Run a GitHub PowerShell script without a token From a46f6d569f5883fc7e7eb3cd32eb21940f0c8300 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 11:24:38 +0100 Subject: [PATCH 13/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Update=20README?= =?UTF-8?q?.md=20to=20reflect=20changes=20in=20script=20path=20examples=20?= =?UTF-8?q?for=20better=20clarity=20and=20consistency?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7affd0a..cf08fde 100644 --- a/README.md +++ b/README.md @@ -74,13 +74,13 @@ The `Script` supports the following formats: - Inline script, although it is recommended to use a script file for better tooling support and linting capabilities. - Multi-line script. - Path to a script file. - - `tests/info.ps1` - - `.\tests\info.ps1` - - `./tests/info.ps1` - - `. .\tests\info.ps1` - - `. ./tests/info.ps1` - - `. '.\tests\info.ps1'` - - `. './tests/info.ps1'` + - `scripts/main.ps1` + - `.\scripts\main.ps1` + - `./scripts/main.ps1` + - `. .\scripts\main.ps1` + - `. ./scripts/main.ps1` + - `. '.\scripts\main.ps1'` + - `. './scripts/main.ps1'` > [!IMPORTANT] > Use `${{ github.action_path }}/` if you are creation an action of your own using this action as a step. This will ensure that From fc8d0806b0254d2d2ec665836bbbfec1d52ea11e Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 11:30:31 +0100 Subject: [PATCH 14/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20a=20blank?= =?UTF-8?q?=20line=20for=20improved=20readability=20in=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index cf08fde..581fae7 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,7 @@ The `Script` supports the following formats: > the path to the script is from the calling action, and not the `GitHub-Script` action repo. Using `$env:GITHUB_ACTION_PATH` may have mixed results > when you nest actions inside one another. The context syntax will be expanded to the correct path at runtime. + > [!WARNING] > Using `tests\info.ps1` is PowerShell syntax for calling a function under a specific module, i.e. `Microsoft.PowerShell.Management\Get-ChildItem`. From 366b002ffd4f14c94da0d4166b03df35d30d7eb0 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 11:34:18 +0100 Subject: [PATCH 15/24] Update README.md to clarify script path usage for custom actions and improve guidance on path resolution --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 581fae7..6bd61e0 100644 --- a/README.md +++ b/README.md @@ -66,9 +66,15 @@ jobs: - name: Run script uses: PSModule/GitHub-Script@v1 with: - Script: scripts/main.ps1 + Script: ${{ github.action_path }}/scripts/main.ps1 ``` +> [!IMPORTANT] +> Use `${{ github.action_path }}/` if you are creation an action of your own using this action as a step. This will ensure that +> the path to the script is from the calling action, and not the `GitHub-Script` action repo. Using `$env:GITHUB_ACTION_PATH` may have mixed results +> when you nest actions inside one another. The context syntax will be expanded to the correct path when the job is evaluted by GitHub before it is +> processed by the runner. + The `Script` supports the following formats: - Inline script, although it is recommended to use a script file for better tooling support and linting capabilities. @@ -82,12 +88,6 @@ The `Script` supports the following formats: - `. '.\scripts\main.ps1'` - `. './scripts/main.ps1'` -> [!IMPORTANT] -> Use `${{ github.action_path }}/` if you are creation an action of your own using this action as a step. This will ensure that -> the path to the script is from the calling action, and not the `GitHub-Script` action repo. Using `$env:GITHUB_ACTION_PATH` may have mixed results -> when you nest actions inside one another. The context syntax will be expanded to the correct path at runtime. - - > [!WARNING] > Using `tests\info.ps1` is PowerShell syntax for calling a function under a specific module, i.e. `Microsoft.PowerShell.Management\Get-ChildItem`. From 0425fc6e3777f846273e548258400374c1b57123 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 12:06:17 +0100 Subject: [PATCH 16/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Update=20README?= =?UTF-8?q?.md=20to=20enhance=20script=20usage=20examples=20and=20clarify?= =?UTF-8?q?=20script=20input=20formats=20for=20better=20understanding?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6bd61e0..d52d9a3 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ To use the outputs in a subsequent step, you can use the following syntax: ### Examples -#### Example 1: Run a GitHub PowerShell script +#### Example 1: Run a GitHub PowerShell script file Run a script (`scripts/main.ps1`) that uses the GitHub PowerShell module, authenticated using the `GITHUB_TOKEN`. @@ -63,7 +63,25 @@ jobs: Run-Script: runs-on: ubuntu-latest steps: - - name: Run script + - name: Run inline script - single line + uses: PSModule/GitHub-Script@v1 + with: + Script: Get-GitHubPullRequest + + - name: Run inline script - multiline + uses: PSModule/GitHub-Script@v1 + with: + Script: | + LogGroup 'Get-GitHubPullRequest' { + Get-GitHubPullRequest + } + + - name: Run script file - Local repository + uses: PSModule/GitHub-Script@v1 + with: + Script: ./scripts/main.ps1 + + - name: Run script file - In a composite action uses: PSModule/GitHub-Script@v1 with: Script: ${{ github.action_path }}/scripts/main.ps1 @@ -75,11 +93,12 @@ jobs: > when you nest actions inside one another. The context syntax will be expanded to the correct path when the job is evaluted by GitHub before it is > processed by the runner. -The `Script` supports the following formats: +The `Script` input supports the following formats: -- Inline script, although it is recommended to use a script file for better tooling support and linting capabilities. -- Multi-line script. -- Path to a script file. +- Inline script: + - Single-line + - Multi-line +- Path to a script file. (recommended) - `scripts/main.ps1` - `.\scripts\main.ps1` - `./scripts/main.ps1` @@ -91,6 +110,11 @@ The `Script` supports the following formats: > [!WARNING] > Using `tests\info.ps1` is PowerShell syntax for calling a function under a specific module, i.e. `Microsoft.PowerShell.Management\Get-ChildItem`. + +> [!TIP] +> Use script files instead of inline scripts for better tooling support and linting capabilities. The PowerShell extension for Visual Studio Code and +> PowerShell linters like PSScriptAnalyzer will work natively with script files. + #### Example 2: Run a GitHub PowerShell script without a token Run a script that uses the GitHub PowerShell module. From efe5cde9a2defe195dad040deda82c1cfac2a139 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 12:19:16 +0100 Subject: [PATCH 17/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20blank=20l?= =?UTF-8?q?ines=20in=20README.md=20for=20improved=20readability=20and=20cl?= =?UTF-8?q?arity=20in=20script=20usage=20sections?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d52d9a3..c28cd2e 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,7 @@ jobs: > the path to the script is from the calling action, and not the `GitHub-Script` action repo. Using `$env:GITHUB_ACTION_PATH` may have mixed results > when you nest actions inside one another. The context syntax will be expanded to the correct path when the job is evaluted by GitHub before it is > processed by the runner. +> The `Script` input supports the following formats: @@ -109,11 +110,12 @@ The `Script` input supports the following formats: > [!WARNING] > Using `tests\info.ps1` is PowerShell syntax for calling a function under a specific module, i.e. `Microsoft.PowerShell.Management\Get-ChildItem`. - +> > [!TIP] > Use script files instead of inline scripts for better tooling support and linting capabilities. The PowerShell extension for Visual Studio Code and > PowerShell linters like PSScriptAnalyzer will work natively with script files. +> #### Example 2: Run a GitHub PowerShell script without a token From dc7d1ffe969cca07e49a21b00b94879f0dcf4bf6 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 12:23:27 +0100 Subject: [PATCH 18/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Improve=20clari?= =?UTF-8?q?ty=20and=20formatting=20in=20README.md=20for=20script=20inputs?= =?UTF-8?q?=20and=20outputs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index c28cd2e..392a404 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,34 @@ # GitHub-Script -A GitHub Action used for running a PowerShell Script that uses the GitHub PowerShell module. +A GitHub Action for running a PowerShell script that uses the GitHub PowerShell module. -For more information on the available functions and automatic loaded variables, see the -[GitHub PowerShell module documentation](https://psmodule.io/GitHub) +For more information on available functions and automatically loaded variables, see the +[GitHub PowerShell module documentation](https://psmodule.io/GitHub). ## Usage ### Inputs -| Name | Description | Required | Default | -| - | - | - | - | -| `Script` | The script to run. Can be inline, multi-line or a path to a script file. | false | | -| `Token` | Log in using an Installation Access Token (IAT). | false | `${{ github.token }}` | -| `ClientID` | Log in using a GitHub App, using the App's Client ID and Private Key. | false | | -| `PrivateKey` | Log in using a GitHub App, using the App's Client ID and Private Key. | false | | -| `Debug` | Enable debug output. | false | `'false'` | -| `Verbose` | Enable verbose output. | false | `'false'` | -| `Version` | Specifies the version of the GitHub module to be installed. The value must be an exact version. | false | | -| `Prerelease` | Allow prerelease versions if available. | false | `'false'` | -| `ShowOutput` | Show the output of the script. | false | `'false'` | -| `WorkingDirectory` | The working directory where the script will run from. | false | `${{ github.workspace }}` | +| Name | Description | Required | Default | +|-------------------|-------------------------------------------------------------------------------------------|----------|------------------------------| +| `Script` | The script to run. Can be inline, multi-line, or a path to a script file. | false | | +| `Token` | Log in using an Installation Access Token (IAT). | false | `${{ github.token }}` | +| `ClientID` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | +| `PrivateKey` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | +| `Debug` | Enable debug output. | false | `'false'` | +| `Verbose` | Enable verbose output. | false | `'false'` | +| `Version` | Specifies the exact version of the GitHub module to install. | false | | +| `Prerelease` | Allow pre-release versions if available. | false | `'false'` | +| `ShowOutput` | Show the script's output. | false | `'false'` | +| `WorkingDirectory`| The working directory where the script runs. | false | `${{ github.workspace }}` | ### Outputs -| Name | Description | -| - | - | -| `result` | The output of the script as a JSON object. To add outputs to `result`, use `Set-GitHubOutput`. | +| Name | Description | +|----------|------------------------------------------------------------------------------------------------------| +| `result` | The script output as a JSON object. To add outputs to `result`, use `Set-GitHubOutput`. | -To use the outputs in a subsequent step, you can use the following syntax: +To use the outputs in a subsequent step, reference them as follows: ```yaml - uses: PSModule/GitHub-Script@v1 @@ -56,7 +56,7 @@ To use the outputs in a subsequent step, you can use the following syntax: #### Example 1: Run a GitHub PowerShell script file -Run a script (`scripts/main.ps1`) that uses the GitHub PowerShell module, authenticated using the `GITHUB_TOKEN`. +Runs a script (`scripts/main.ps1`) that uses the GitHub PowerShell module, authenticated using the `GITHUB_TOKEN`. ```yaml jobs: @@ -112,6 +112,7 @@ The `Script` input supports the following formats: > Using `tests\info.ps1` is PowerShell syntax for calling a function under a specific module, i.e. `Microsoft.PowerShell.Management\Get-ChildItem`. > + > [!TIP] > Use script files instead of inline scripts for better tooling support and linting capabilities. The PowerShell extension for Visual Studio Code and > PowerShell linters like PSScriptAnalyzer will work natively with script files. From b41e11feeb69e1db84a3fa14f7d4447a409b9a03 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 12:27:55 +0100 Subject: [PATCH 19/24] Refactor README.md for improved clarity and consistency in script input descriptions and examples --- README.md | 69 +++++++++++++++++++++++++------------------------------ 1 file changed, 31 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 392a404..53f2bc8 100644 --- a/README.md +++ b/README.md @@ -9,18 +9,18 @@ For more information on available functions and automatically loaded variables, ### Inputs -| Name | Description | Required | Default | -|-------------------|-------------------------------------------------------------------------------------------|----------|------------------------------| -| `Script` | The script to run. Can be inline, multi-line, or a path to a script file. | false | | -| `Token` | Log in using an Installation Access Token (IAT). | false | `${{ github.token }}` | -| `ClientID` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | -| `PrivateKey` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | -| `Debug` | Enable debug output. | false | `'false'` | -| `Verbose` | Enable verbose output. | false | `'false'` | -| `Version` | Specifies the exact version of the GitHub module to install. | false | | -| `Prerelease` | Allow pre-release versions if available. | false | `'false'` | -| `ShowOutput` | Show the script's output. | false | `'false'` | -| `WorkingDirectory`| The working directory where the script runs. | false | `${{ github.workspace }}` | +| Name | Description | Required | Default | +|--------------------|-------------------------------------------------------------------------------------------|----------|------------------------------| +| `Script` | The script to run. Can be inline, multi-line, or a path to a script file. | false | | +| `Token` | Log in using an Installation Access Token (IAT). | false | `${{ github.token }}` | +| `ClientID` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | +| `PrivateKey` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | +| `Debug` | Enable debug output. | false | `'false'` | +| `Verbose` | Enable verbose output. | false | `'false'` | +| `Version` | Specifies the exact version of the GitHub module to install. | false | | +| `Prerelease` | Allow pre-release versions if available. | false | `'false'` | +| `ShowOutput` | Show the script's output. | false | `'false'` | +| `WorkingDirectory` | The working directory where the script runs. | false | `${{ github.workspace }}` | ### Outputs @@ -51,7 +51,6 @@ To use the outputs in a subsequent step, reference them as follows: Write-Output $result.Octocat.Image ``` - ### Examples #### Example 1: Run a GitHub PowerShell script file @@ -88,18 +87,16 @@ jobs: ``` > [!IMPORTANT] -> Use `${{ github.action_path }}/` if you are creation an action of your own using this action as a step. This will ensure that -> the path to the script is from the calling action, and not the `GitHub-Script` action repo. Using `$env:GITHUB_ACTION_PATH` may have mixed results -> when you nest actions inside one another. The context syntax will be expanded to the correct path when the job is evaluted by GitHub before it is -> processed by the runner. -> +> Use `${{ github.action_path }}/` if you are creating an action of your own that uses this action as a step. This ensures +> the path references your action rather than the `GitHub-Script` action repository. Using `$env:GITHUB_ACTION_PATH` can lead to mixed results +> when nesting actions. The context syntax will expand to the correct path when the job is evaluated by GitHub before being processed by the runner. -The `Script` input supports the following formats: +The `Script` input supports these formats: - Inline script: - Single-line - Multi-line -- Path to a script file. (recommended) +- Path to a script file (recommended): - `scripts/main.ps1` - `.\scripts\main.ps1` - `./scripts/main.ps1` @@ -109,19 +106,16 @@ The `Script` input supports the following formats: - `. './scripts/main.ps1'` > [!WARNING] -> Using `tests\info.ps1` is PowerShell syntax for calling a function under a specific module, i.e. `Microsoft.PowerShell.Management\Get-ChildItem`. -> +> Using `tests\info.ps1` is PowerShell syntax for calling a function from a specific module (e.g., `Microsoft.PowerShell.Management\Get-ChildItem`). > [!TIP] -> Use script files instead of inline scripts for better tooling support and linting capabilities. The PowerShell extension for Visual Studio Code and -> PowerShell linters like PSScriptAnalyzer will work natively with script files. -> +> Use script files instead of inline scripts for better tooling support and linting. The PowerShell extension for Visual Studio Code and +> linters like PSScriptAnalyzer work natively with script files. #### Example 2: Run a GitHub PowerShell script without a token -Run a script that uses the GitHub PowerShell module. -This example runs a non-authenticated script that gets the GitHub Zen message. +Runs a non-authenticated script that retrieves the GitHub Zen message. ```yaml jobs: @@ -140,8 +134,8 @@ jobs: #### Example 3: Run a GitHub PowerShell script with a custom token -Run a script that uses the GitHub PowerShell module with a token. The token can be both a personal access token (PAT) or -an installation access token (IAT). This example runs an authenticated script that gets the GitHub Zen message. +Runs a script that uses the GitHub PowerShell module with a token. The token can be a personal access token (PAT) or +an installation access token (IAT). This example retrieves the GitHub Zen message. ```yaml jobs: @@ -160,8 +154,7 @@ jobs: #### Example 4: Run a GitHub PowerShell script with a GitHub App using a Client ID and Private Key -Run a script that uses the GitHub PowerShell module with a GitHub App. -This example runs an authenticated script that gets the GitHub App. +Runs a script that uses the GitHub PowerShell module with a GitHub App. This example retrieves the GitHub App details. ```yaml jobs: @@ -179,9 +172,9 @@ jobs: } ``` -#### Example 5: Using the outputs from the script +#### Example 5: Using outputs from the script -Run a script that uses the GitHub PowerShell module and outputs the result. +Runs a script that uses the GitHub PowerShell module and outputs the result. ```yaml - name: Run GitHub Script @@ -199,13 +192,13 @@ Run a script that uses the GitHub PowerShell module and outputs the result. env: result: ${{ steps.test.outputs.result }} run: | - $result = $env:result | ConvertFrom-Json - Set-GitHubStepSummary -Summary $result.WISECAT - Write-GitHubNotice -Message $result.Zen -Title 'GitHub Zen' + $result = $env:result | ConvertFrom-Json + Set-GitHubStepSummary -Summary $result.WISECAT + Write-GitHubNotice -Message $result.Zen -Title 'GitHub Zen' ``` -## Related projects +## Related Projects -- [actions/create-github-app-token](https://github.com/actions/create-github-app-token) -> Functionality will be brought into GitHub PowerShell module. +- [actions/create-github-app-token](https://github.com/actions/create-github-app-token) – Functionality will be incorporated into the GitHub PowerShell module. - [actions/github-script](https://github.com/actions/github-script) - [PSModule/GitHub](https://github.com/PSModule/GitHub) From 66fb6a8255b7de99e3f68e1a834883e5b731f041 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 12:40:55 +0100 Subject: [PATCH 20/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Improve=20forma?= =?UTF-8?q?tting=20and=20clarity=20in=20README.md=20for=20script=20inputs?= =?UTF-8?q?=20and=20outputs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 38 ++++++++++++++++---------------------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 53f2bc8..94194c2 100644 --- a/README.md +++ b/README.md @@ -9,24 +9,24 @@ For more information on available functions and automatically loaded variables, ### Inputs -| Name | Description | Required | Default | -|--------------------|-------------------------------------------------------------------------------------------|----------|------------------------------| -| `Script` | The script to run. Can be inline, multi-line, or a path to a script file. | false | | -| `Token` | Log in using an Installation Access Token (IAT). | false | `${{ github.token }}` | -| `ClientID` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | -| `PrivateKey` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | -| `Debug` | Enable debug output. | false | `'false'` | -| `Verbose` | Enable verbose output. | false | `'false'` | -| `Version` | Specifies the exact version of the GitHub module to install. | false | | -| `Prerelease` | Allow pre-release versions if available. | false | `'false'` | -| `ShowOutput` | Show the script's output. | false | `'false'` | -| `WorkingDirectory` | The working directory where the script runs. | false | `${{ github.workspace }}` | +| Name | Description | Required | Default | +|--------------------|---------------------------------------------------------------------------|----------|---------------------------| +| `Script` | The script to run. Can be inline, multi-line, or a path to a script file. | false | | +| `Token` | Log in using an Installation Access Token (IAT). | false | `${{ github.token }}` | +| `ClientID` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | +| `PrivateKey` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | | +| `Debug` | Enable debug output. | false | `'false'` | +| `Verbose` | Enable verbose output. | false | `'false'` | +| `Version` | Specifies the exact version of the GitHub module to install. | false | | +| `Prerelease` | Allow pre-release versions if available. | false | `'false'` | +| `ShowOutput` | Show the script's output. | false | `'false'` | +| `WorkingDirectory` | The working directory where the script runs. | false | `${{ github.workspace }}` | ### Outputs -| Name | Description | -|----------|------------------------------------------------------------------------------------------------------| -| `result` | The script output as a JSON object. To add outputs to `result`, use `Set-GitHubOutput`. | +| Name | Description | +|----------|---------------------------------------------------------------------------------------- | +| `result` | The script output as a JSON object. To add outputs to `result`, use `Set-GitHubOutput`. | To use the outputs in a subsequent step, reference them as follows: @@ -110,7 +110,7 @@ The `Script` input supports these formats: > [!TIP] -> Use script files instead of inline scripts for better tooling support and linting. The PowerShell extension for Visual Studio Code and +> Use script files instead of inline scripts for better support for development tools and linters. The PowerShell extension for Visual Studio Code and > linters like PSScriptAnalyzer work natively with script files. #### Example 2: Run a GitHub PowerShell script without a token @@ -196,9 +196,3 @@ Runs a script that uses the GitHub PowerShell module and outputs the result. Set-GitHubStepSummary -Summary $result.WISECAT Write-GitHubNotice -Message $result.Zen -Title 'GitHub Zen' ``` - -## Related Projects - -- [actions/create-github-app-token](https://github.com/actions/create-github-app-token) – Functionality will be incorporated into the GitHub PowerShell module. -- [actions/github-script](https://github.com/actions/github-script) -- [PSModule/GitHub](https://github.com/PSModule/GitHub) From 41550bd44c468039a6bac35bba4578e94c411be4 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 12:43:53 +0100 Subject: [PATCH 21/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Correct=20spell?= =?UTF-8?q?ing=20of=20'prerelease'=20in=20README.md=20for=20consistency?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 94194c2..ae35e8d 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ For more information on available functions and automatically loaded variables, | `Debug` | Enable debug output. | false | `'false'` | | `Verbose` | Enable verbose output. | false | `'false'` | | `Version` | Specifies the exact version of the GitHub module to install. | false | | -| `Prerelease` | Allow pre-release versions if available. | false | `'false'` | +| `Prerelease` | Allow prerelease versions if available. | false | `'false'` | | `ShowOutput` | Show the script's output. | false | `'false'` | | `WorkingDirectory` | The working directory where the script runs. | false | `${{ github.workspace }}` | From f64d24ed40cb4e58c5bb685004b05b755ea5b7dc Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 12:44:50 +0100 Subject: [PATCH 22/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20markdown?= =?UTF-8?q?=20linter=20configuration=20for=20improved=20consistency=20in?= =?UTF-8?q?=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/linters/.markdown-lint.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/linters/.markdown-lint.yml diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml new file mode 100644 index 0000000..2ca7e45 --- /dev/null +++ b/.github/linters/.markdown-lint.yml @@ -0,0 +1,25 @@ +########################### +## Markdown Linter rules ## +########################### + +# Linter rules doc: +# - https://github.com/DavidAnson/markdownlint + +############### +# Rules by ID # +############### +MD004: false # Unordered list style +MD007: + indent: 2 # Unordered list indentation +MD013: + line_length: 808 # Line length +MD026: + punctuation: '.,;:!。，；:' # List of not allowed +MD029: false # Ordered list item prefix +MD033: false # Allow inline HTML +MD036: false # Emphasis used instead of a heading + +################# +# Rules by tags # +################# +blank_lines: false # Error on blank lines From 4f9e84a317c52ccb1ae7b4d4d7da7a84924c900a Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 12:52:27 +0100 Subject: [PATCH 23/24] Fix markdown linting issue in README.md by disabling the rule for a specific line --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ae35e8d..591deb1 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ The `Script` input supports these formats: > [!WARNING] > Using `tests\info.ps1` is PowerShell syntax for calling a function from a specific module (e.g., `Microsoft.PowerShell.Management\Get-ChildItem`). - + > [!TIP] > Use script files instead of inline scripts for better support for development tools and linters. The PowerShell extension for Visual Studio Code and From 1b3adb357da3fa8a88aa8fb438882ca5ab51e4d7 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 22 Jan 2025 12:55:34 +0100 Subject: [PATCH 24/24] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Remove=20markdo?= =?UTF-8?q?wn=20linter=20configuration=20file=20as=20it=20is=20no=20longer?= =?UTF-8?q?=20needed?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/linters/.markdown-lint.yml | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 .github/linters/.markdown-lint.yml diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml deleted file mode 100644 index 2ca7e45..0000000 --- a/.github/linters/.markdown-lint.yml +++ /dev/null @@ -1,25 +0,0 @@ -########################### -## Markdown Linter rules ## -########################### - -# Linter rules doc: -# - https://github.com/DavidAnson/markdownlint - -############### -# Rules by ID # -############### -MD004: false # Unordered list style -MD007: - indent: 2 # Unordered list indentation -MD013: - line_length: 808 # Line length -MD026: - punctuation: '.,;:!。，；:' # List of not allowed -MD029: false # Ordered list item prefix -MD033: false # Allow inline HTML -MD036: false # Emphasis used instead of a heading - -################# -# Rules by tags # -################# -blank_lines: false # Error on blank lines