Skip to content

🩹 [Patch]: Update tests to perform a linter evaluation #20

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

Closed
MariusStorhaug wants to merge 2 commits into from
Closed

🩹 [Patch]: Update tests to perform a linter evaluation #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91b2259
🩹 [Patch]: Update GitHub Actions workflow permissions and add documen…
MariusStorhaug Oct 6, 2025
25cc2d6
🩹 [Patch]: Update New-MarkdownHelp command to use UTF8 encoding for o…
MariusStorhaug Oct 6, 2025
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
25 changes: 24 additions & 1 deletion .github/workflows/Action-Test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

permissions: {}
permissions:
contents: read # to checkout the repo
statuses: write # to create commit status

jobs:
ActionTestDefault:
Expand All @@ -24,6 +26,9 @@
steps:
- name: Checkout repo
uses: actions/checkout@v5
with:
persist-credentials: false
fetch-depth: 0

- name: Upload module artifact
uses: actions/upload-artifact@v4
Expand All @@ -38,3 +43,21 @@
with:
Name: PSModuleTest
WorkingDirectory: tests/srcTestRepo

- name: Get changes
uses: PSModule/GitHub-Script@v1
with:
Script: |
LogGroup "List files" {
Get-ChildItem -Recurse -File | Select-Object -ExpandProperty FullName | Sort-Object
}
LogGroup "Commit changes" {
git add tests/srcTestRepo/outputs/docs/
git commit -m "Update documentation"
}
Comment on lines +54 to +57
Copy link

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The workflow attempts to commit changes without configuring git user identity. This will likely fail unless git user.name and user.email are configured in the environment or the repository has specific settings.

Copilot uses AI. Check for mistakes.
- name: Lint documentation
uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0
env:
GITHUB_TOKEN: ${{ github.token }}
VALIDATE_MARKDOWN: true
2 changes: 1 addition & 1 deletion scripts/helpers/Build-PSModuleDocumentation.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
Write-Host '::group::Build docs - Generate markdown help - Raw'
Install-PSModule -Path $ModuleOutputFolder
Write-Host ($ModuleName | Get-Module)
$null = New-MarkdownHelp -Module $ModuleName -OutputFolder $DocsOutputFolder -Force -Verbose
$null = New-MarkdownHelp -Module $ModuleName -OutputFolder $DocsOutputFolder -Force -Encoding UTF8
Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object {
$fileName = $_.Name
Write-Host "::group:: - [$fileName]"
Expand Down
6 changes: 6 additions & 0 deletions tests/srcTestRepo/outputs/module/PSModuleTest/PSModuleTest.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,12 @@ function Set-PSModuleTest {
Test-PSModule -Name 'World'

"Hello, World!"

.NOTES
Controls:
- :q : Quit
- :q! : Quit without saving
- :wq : Save and quit
Comment on lines +319 to +322
Copy link

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The .NOTES section contains control commands that appear to be vim/vi editor commands, which are not relevant to a PowerShell function. This documentation should describe the function's behavior, usage notes, or implementation details specific to Set-PSModuleTest.

Suggested change
Controls:
- :q : Quit
- :q! : Quit without saving
- :wq : Save and quit
This function outputs a greeting message for the specified name.

Copilot uses AI. Check for mistakes.
#>
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function',
Expand Down
6 changes: 6 additions & 0 deletions tests/srcTestRepo/src/functions/public/SomethingElse/Set-PSModuleTest.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
Test-PSModule -Name 'World'
"Hello, World!"
.NOTES
Controls:
- :q : Quit
- :q! : Quit without saving
- :wq : Save and quit
Comment on lines +12 to +15
Copy link

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The .NOTES section contains control commands that appear to be vim/vi editor commands, which are not relevant to a PowerShell function. This documentation should describe the function's behavior, usage notes, or implementation details specific to Set-PSModuleTest.

Suggested change
Controls:
- :q : Quit
- :q! : Quit without saving
- :wq : Save and quit
This function outputs a greeting message for the specified module name. Add additional implementation notes here as needed.

Copilot uses AI. Check for mistakes.
#>
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function',
Expand Down
Loading