Skip to content

Commit 9810ff9

Browse files
🔧 [Docs]: Update README to clarify module compilation and testing processes
1 parent 54b3ebb commit 9810ff9

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

‎README.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,20 @@ Depending on the labels in the pull requests, the workflow will result in differ
2525
- Gathers tests and creates test configuration based on the settings and the tests available in the module repository.
2626
- This includes the selection of what OSes to run the tests on.
2727
- [Build-Module](./.github/workflows/Build-Module.yml)
28-
- Compiles the module source code into a PowerShell module using a temporary version `999.0.0`.
28+
- Compiles the module source code into a PowerShell module.
2929
- [Test-SourceCode](./.github/workflows/Test-SourceCode.yml)
30-
- Tests and lints the source code using [PSModule framework settings for style and standards for source code](https://github.com/PSModule/Test-PSModule?tab=readme-ov-file#sourcecode-tests) + [PSScriptAnalyzer rules](https://github.com/PSModule/Invoke-ScriptAnalyzer).
30+
- Tests and lints the source code in parallel (matrix) using [PSModule framework settings for style and standards for source code](https://github.com/PSModule/Test-PSModule?tab=readme-ov-file#sourcecode-tests) + [PSScriptAnalyzer rules](https://github.com/PSModule/Invoke-ScriptAnalyzer).
3131
- This produces a json based report that is used to later evaluate the results of the tests.
3232
- [Test-Module](./.github/workflows/Test-Module.yml)
33-
- Tests and lints the module using [PSModule framework settings for style and standards foor modules](https://github.com/PSModule/Test-PSModule?tab=readme-ov-file#module-tests) + [PSScriptAnalyzer rules](https://github.com/PSModule/Invoke-ScriptAnalyzer).
33+
- Tests and lints the module in parallel (matrix) using [PSModule framework settings for style and standards foor modules](https://github.com/PSModule/Test-PSModule?tab=readme-ov-file#module-tests) + [PSScriptAnalyzer rules](https://github.com/PSModule/Invoke-ScriptAnalyzer).
3434
- This produces a json based report that is used to later evaluate the results of the tests.
3535
- [Test-ModuleLocal](./.github/workflows/Test-ModuleLocal.yml)
36-
- Import and tests the module using Pester test from the module repository.
36+
- Import and tests the module in parallel (matrix) using Pester tests from the module repository.
3737
- This produces a json based report that is used to later evaluate the results of the tests.
3838
- [Build-Docs](./.github/workflows/Build-Docs.yml)
39-
- Generates documentation
39+
- Generates documentation and lints the documentation using [SuperLinter](https://github.com/super-linter/super-linter).
40+
- [Build-Site](./.github/workflows/Build-Site.yml)
41+
- Generates a static site using [MkDocs](https://www.mkdocs.org/).
4042
- [Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests the compiled module. This runs on 4 different environments to check compatibility.
4143
- PowerShell LTS on Windows, Ubuntu and macOS.
4244
- [Publish-PSModule](https://github.com/PSModule/Publish-PSModule/) - Publishes the module to the PowerShell Gallery, docs to GitHub Pages, and creates a release on the GitHub repository.

0 commit comments

Comments
 (0)