You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 30bf28d
Browse filesBrowse the repository at this point in the historyBrowse files
## Description
This pull request includes updating the reusable workflows for CI and
CD, separating documentation generation to a separate stage, using
[`Document-PSModule`](https://github.com/PSModule/Document-PSModule/)
and updating the
[`Build-PSModule`](https://github.com/PSModule/Build-PSModule/) version
to the latest which does not have the documentation steps in it.
### Workflow and Documentation Updates:
* Updated `Build-PSModule` action from version 2 to version 3.
* Added a new `BuildDocs` job to the workflows to generate
documentation.
* Changed the `LintDocs` job to depend on the new `BuildDocs` job
instead of `BuildModule`.
* Updated the README to include the new `Document` step in the workflow
description and updated the testing environments.
## Type of change
<!-- Use the check-boxes [x] on the options that are relevant. -->
- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]
## Checklist
<!-- Use the check-boxes [x] on the options that are relevant. -->
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
Copy file name to clipboardExpand all lines: README.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Process-PSModule
2
2
3
-
A workflow for the PSModule process, stitching together the `Initialize`, `Build`, `Test`, and `Publish` actions to create a complete
3
+
A workflow for the PSModule process, stitching together the `Initialize`, `Build`, `Document`, `Test`, and `Publish` actions to create a complete
4
4
CI/CD pipeline for PowerShell modules. The workflow is used by all PowerShell modules in the PSModule organization.
5
5
6
6
## Specifications and practices
@@ -20,13 +20,12 @@ Depending on the labels in the pull requests, the workflow will result in differ
20
20
21
21

22
22
23
-
-[Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests the source code using PSScriptAnalyzer, PSModule source code tests suites. This runs on 4 different environments to check compatibility.
24
-
- PowerShell 7.x on Windows, Ubuntu and macOS.
25
-
- Windows PowerShell 5.1 on Windows.
23
+
-[Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests and lints the source code. This runs on 3 different environments to check compatibility.
24
+
- PowerShell LTS on Windows, Ubuntu and macOS.
26
25
-[Build-PSModule](https://github.com/PSModule/Build-PSModule/) - Compiles the repository into an efficient PowerShell module.
27
-
-[Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests the compiled module using PSScriptAnalyzer, PSModule module tests and custom module tests from the module repository. This runs on 4 different environments to check compatibility.
28
-
-PowerShell 7.x on Windows, Ubuntu and macOS.
29
-
-Windows PowerShell 5.1 on Windows.
26
+
-[Document-PSModule](https://github.com/PSModule/Document-PSModule/) - Generates documentation and deploys it to GitHub Pages.
27
+
-[Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests the compiled module. This runs on 4 different environments to check compatibility.
28
+
- PowerShell LTS on Windows, Ubuntu and macOS.
30
29
-[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.
31
30
32
31
To use the workflow, create a new file in the `.github/workflows` directory of the module repository and add the following content.
0 commit comments