@@ -76,6 +76,14 @@ Depending on the labels in the pull requests, the [workflow will result in diffe
7676 - [ Configuring Linter Validation Rules] ( #configuring-linter-validation-rules )
7777 - [ Additional Configuration] ( #additional-configuration )
7878 - [ Showing Linter Summary on Success] ( #showing-linter-summary-on-success )
79+ - [ Skipping Individual Framework Tests] ( #skipping-individual-framework-tests )
80+ - [ How to Skip Tests] ( #how-to-skip-tests )
81+ - [ Available Framework Tests] ( #available-framework-tests )
82+ - [ SourceCode Tests] ( #sourcecode-tests )
83+ - [ Module Tests] ( #module-tests-1 )
84+ - [ Example Usage] ( #example-usage )
85+ - [ Best Practices] ( #best-practices )
86+ - [ Related Configuration] ( #related-configuration )
7987 - [ Repository structure] ( #repository-structure )
8088 - [ Module source code structure] ( #module-source-code-structure )
8189 - [ Principles and practices] ( #principles-and-practices )
@@ -91,21 +99,21 @@ Depending on the labels in the pull requests, the [workflow will result in diffe
9199### Get settings
92100
93101[ workflow] ( #get-settings )
94- - Reads the settings file ` github/PSModule.yml ` in the module repository to configure the workflow.
95- - Gathers context for the process from GitHub and the repo files, configuring what tests to run, if and what kind of release to create, and wether
96- to setup testing infrastructure and what operating systems to run the tests on.
102+ - Reads the settings file ` github/PSModule.yml ` in the module repository to configure the workflow.
103+ - Gathers context for the process from GitHub and the repo files, configuring what tests to run, if and what kind of release to create, and wether
104+ to setup testing infrastructure and what operating systems to run the tests on.
97105
98106### Build module
99107
100108[ workflow] ( ./.github/workflows/Build-Module.yml )
101- - Compiles the module source code into a PowerShell module.
109+ - Compiles the module source code into a PowerShell module.
102110
103111### Test source code
104112
105113[ workflow] ( ./.github/workflows/Test-SourceCode.yml )
106- - Tests the source code in parallel (matrix) using:
107- - [ PSModule framework settings for style and standards for source code] ( https://github.com/PSModule/Test-PSModule?tab=readme-ov-file#sourcecode-tests )
108- - This produces a JSON-based report that is used by [ Get-PesterTestResults] ( #get-test-results ) evaluate the results of the tests.
114+ - Tests the source code in parallel (matrix) using:
115+ - [ PSModule framework settings for style and standards for source code] ( https://github.com/PSModule/Test-PSModule?tab=readme-ov-file#sourcecode-tests )
116+ - This produces a JSON-based report that is used by [ Get-PesterTestResults] ( #get-test-results ) evaluate the results of the tests.
109117
110118The [ PSModule - SourceCode tests] ( ./scripts/tests/SourceCode/PSModule/PSModule.Tests.ps1 ) verifies the following coding practices that the framework enforces:
111119
@@ -126,27 +134,27 @@ The [PSModule - SourceCode tests](./scripts/tests/SourceCode/PSModule/PSModule.T
126134### Lint source code
127135
128136[ workflow] ( ./.github/workflows/Lint-SourceCode.yml )
129- - Lints the source code in parallel (matrix) using:
130- - [ PSScriptAnalyzer rules] ( https://github.com/PSModule/Invoke-ScriptAnalyzer )
131- - This produces a JSON-based report that is used by [ Get-PesterTestResults] ( #get-test-results ) evaluate the results of the linter.
137+ - Lints the source code in parallel (matrix) using:
138+ - [ PSScriptAnalyzer rules] ( https://github.com/PSModule/Invoke-ScriptAnalyzer )
139+ - This produces a JSON-based report that is used by [ Get-PesterTestResults] ( #get-test-results ) evaluate the results of the linter.
132140
133141### Framework test
134142
135143[ workflow] ( ./.github/workflows/Test-Module.yml )
136- - Tests and lints the module in parallel (matrix) using:
137- - [ PSModule framework settings for style and standards for modules] ( https://github.com/PSModule/Test-PSModule?tab=readme-ov-file#module-tests )
138- - [ PSScriptAnalyzer rules] ( https://github.com/PSModule/Invoke-ScriptAnalyzer )
139- - This produces a JSON-based report that is used by [ Get-PesterTestResults] ( #get-test-results ) evaluate the results of the tests.
144+ - Tests and lints the module in parallel (matrix) using:
145+ - [ PSModule framework settings for style and standards for modules] ( https://github.com/PSModule/Test-PSModule?tab=readme-ov-file#module-tests )
146+ - [ PSScriptAnalyzer rules] ( https://github.com/PSModule/Invoke-ScriptAnalyzer )
147+ - This produces a JSON-based report that is used by [ Get-PesterTestResults] ( #get-test-results ) evaluate the results of the tests.
140148
141149### Test module
142150
143151[ workflow] ( ./.github/workflows/Test-ModuleLocal.yml )
144- - Imports and tests the module in parallel (matrix) using Pester tests from the module repository.
145- - Supports setup and teardown scripts executed via separate dedicated jobs:
146- - ` BeforeAll ` : Runs once before all test matrix jobs to set up the test environment (e.g., deploy infrastructure, download test data).
147- - ` AfterAll ` : Runs once after all test matrix jobs complete to clean up the test environment (e.g., remove test resources, clean up databases).
148- - Setup/teardown scripts are automatically detected in test directories and executed with the same environment variables as the tests.
149- - This produces a JSON-based report that is used by [ Get-PesterTestResults] ( #get-test-results ) evaluate the results of the tests.
152+ - Imports and tests the module in parallel (matrix) using Pester tests from the module repository.
153+ - Supports setup and teardown scripts executed via separate dedicated jobs:
154+ - ` BeforeAll ` : Runs once before all test matrix jobs to set up the test environment (e.g., deploy infrastructure, download test data).
155+ - ` AfterAll ` : Runs once after all test matrix jobs complete to clean up the test environment (e.g., remove test resources, clean up databases).
156+ - Setup/teardown scripts are automatically detected in test directories and executed with the same environment variables as the tests.
157+ - This produces a JSON-based report that is used by [ Get-PesterTestResults] ( #get-test-results ) evaluate the results of the tests.
150158
151159#### Setup and Teardown Scripts
152160
0 commit comments