Skip to content

Commit b1fbc71

Browse files
🔧 [CI]: Remove unused Prescript from Test-ModuleLocal workflow
1 parent c27c723 commit b1fbc71

File tree

4 files changed

+47
-20
lines changed

4 files changed

+47
-20
lines changed

.github/workflows/Test-ModuleLocal.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,5 +130,3 @@ jobs:
130130
Path: ${{ inputs.TestPath }}
131131
Run_Path: ${{ steps.import-module.outputs.path }}
132132
WorkingDirectory: ${{ inputs.WorkingDirectory }}
133-
Prescript: |
134-
Import-Module -Name '${{ steps.import-module.outputs.name }}' -RequiredVersion 999.0.0

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Process-PSModule
22

3-
4-
A workflow for the PSModule process, stitching together the `Initialize`, `Build`, `Document`, `Test`, and `Publish` actions to create a complete
5-
CI/CD pipeline for PowerShell modules. The workflow is used by all PowerShell modules in the PSModule organization.
3+
A workflow for crafting PowerShell modules using the PSModule framework, which builds, tests and publishes PowerShell modules to the PowerShell
4+
Gallery and produces documentation that is published to GitHub Pages. The workflow is used by all PowerShell modules in the PSModule organization.
65

76
## Specifications and practices
87

@@ -21,9 +20,21 @@ Depending on the labels in the pull requests, the workflow will result in differ
2120

2221
![Process diagram](./media/Process-PSModule.png)
2322

24-
- [Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests and lints the source code. This runs on 3 different environments to check compatibility.
25-
- PowerShell LTS on Windows, Ubuntu and macOS.
26-
- [Build-PSModule](https://github.com/PSModule/Build-PSModule/) - Compiles the repository into an efficient PowerShell module.
23+
- [Get-Settings](./.github/workflows/Get-Settings.yml)
24+
- Reads the settings file from a file in the module repository to configure the workflow.
25+
- Gathers tests and creates test configuration based on the settings and the tests available in the module repository.
26+
- This includes the selection of what OSes to run the tests on.
27+
- [Build-Module](./.github/workflows/Build-Module.yml)
28+
- Compiles the module source code into a PowerShell module using a temporary version `999.0.0`.
29+
- [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).
31+
- This produces a json based report that is used to later evaluate the results of the tests.
32+
- [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).
34+
- This produces a json based report that is used to later evaluate the results of the tests.
35+
- [Test-ModuleLocal](./.github/workflows/Test-ModuleLocal.yml)
36+
- Import and tests the module using Pester test from the module repository.
37+
- This produces a json based report that is used to later evaluate the results of the tests.
2738
- [Document-PSModule](https://github.com/PSModule/Document-PSModule/) - Generates documentation and deploys it to GitHub Pages.
2839
- [Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests the compiled module. This runs on 4 different environments to check compatibility.
2940
- PowerShell LTS on Windows, Ubuntu and macOS.

media/Flow.drawio

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<mxfile host="65bd71144e">
22
<diagram name="Page-1" id="AVgqyzCaT5g_HGF3t2XU">
3-
<mxGraphModel dx="1133" dy="728" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
3+
<mxGraphModel dx="1414" dy="534" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
44
<root>
55
<mxCell id="0"/>
66
<mxCell id="1" parent="0"/>
@@ -13,27 +13,30 @@
1313
<mxCell id="7" style="edgeStyle=orthogonalEdgeStyle;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;rounded=1;curved=0;" parent="1" source="pFe5YTL7qQIc07WUC1TG-1" target="4" edge="1">
1414
<mxGeometry relative="1" as="geometry"/>
1515
</mxCell>
16-
<mxCell id="8" style="edgeStyle=orthogonalEdgeStyle;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;rounded=1;curved=0;" parent="1" source="pFe5YTL7qQIc07WUC1TG-1" target="pFe5YTL7qQIc07WUC1TG-2" edge="1">
17-
<mxGeometry relative="1" as="geometry"/>
16+
<mxCell id="8" style="edgeStyle=orthogonalEdgeStyle;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;rounded=1;curved=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="pFe5YTL7qQIc07WUC1TG-17" target="pFe5YTL7qQIc07WUC1TG-10" edge="1">
17+
<mxGeometry relative="1" as="geometry">
18+
<mxPoint x="240" y="420.5" as="targetPoint"/>
19+
<Array as="points">
20+
<mxPoint x="375" y="390"/>
21+
<mxPoint x="375" y="357"/>
22+
</Array>
23+
</mxGeometry>
1824
</mxCell>
1925
<mxCell id="14" style="edgeStyle=orthogonalEdgeStyle;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;rounded=1;curved=0;" parent="1" source="pFe5YTL7qQIc07WUC1TG-1" target="13" edge="1">
2026
<mxGeometry relative="1" as="geometry"/>
2127
</mxCell>
2228
<mxCell id="pFe5YTL7qQIc07WUC1TG-1" value="Build module" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
23-
<mxGeometry x="70" y="262.5" width="120" height="60" as="geometry"/>
29+
<mxGeometry x="179" y="262.5" width="120" height="60" as="geometry"/>
2430
</mxCell>
25-
<mxCell id="pFe5YTL7qQIc07WUC1TG-6" style="edgeStyle=orthogonalEdgeStyle;rounded=1;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;curved=0;" parent="1" source="pFe5YTL7qQIc07WUC1TG-2" target="pFe5YTL7qQIc07WUC1TG-4" edge="1">
31+
<mxCell id="pFe5YTL7qQIc07WUC1TG-6" style="edgeStyle=orthogonalEdgeStyle;rounded=1;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;curved=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="pFe5YTL7qQIc07WUC1TG-1" target="pFe5YTL7qQIc07WUC1TG-4" edge="1">
2632
<mxGeometry relative="1" as="geometry"/>
2733
</mxCell>
28-
<mxCell id="pFe5YTL7qQIc07WUC1TG-7" style="edgeStyle=orthogonalEdgeStyle;rounded=1;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;curved=0;" parent="1" source="pFe5YTL7qQIc07WUC1TG-2" target="pFe5YTL7qQIc07WUC1TG-3" edge="1">
34+
<mxCell id="pFe5YTL7qQIc07WUC1TG-7" style="edgeStyle=orthogonalEdgeStyle;rounded=1;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;curved=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="pFe5YTL7qQIc07WUC1TG-1" target="pFe5YTL7qQIc07WUC1TG-3" edge="1">
2935
<mxGeometry relative="1" as="geometry"/>
3036
</mxCell>
31-
<mxCell id="pFe5YTL7qQIc07WUC1TG-8" style="edgeStyle=orthogonalEdgeStyle;rounded=1;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;curved=0;" parent="1" source="pFe5YTL7qQIc07WUC1TG-2" target="pFe5YTL7qQIc07WUC1TG-5" edge="1">
37+
<mxCell id="pFe5YTL7qQIc07WUC1TG-8" style="edgeStyle=orthogonalEdgeStyle;rounded=1;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;curved=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="pFe5YTL7qQIc07WUC1TG-1" target="pFe5YTL7qQIc07WUC1TG-5" edge="1">
3238
<mxGeometry relative="1" as="geometry"/>
3339
</mxCell>
34-
<mxCell id="pFe5YTL7qQIc07WUC1TG-2" value="Gather local&lt;br&gt;&lt;span style=&quot;background-color: transparent;&quot;&gt;test&lt;/span&gt;" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
35-
<mxGeometry x="240" y="390.5" width="120" height="60" as="geometry"/>
36-
</mxCell>
3740
<mxCell id="pFe5YTL7qQIc07WUC1TG-11" style="edgeStyle=orthogonalEdgeStyle;rounded=1;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;curved=0;" parent="1" source="pFe5YTL7qQIc07WUC1TG-3" target="pFe5YTL7qQIc07WUC1TG-10" edge="1">
3841
<mxGeometry relative="1" as="geometry"/>
3942
</mxCell>
@@ -67,10 +70,10 @@
6770
<mxGeometry x="560" y="327" width="120" height="60" as="geometry"/>
6871
</mxCell>
6972
<mxCell id="pFe5YTL7qQIc07WUC1TG-14" value="Run test A" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
70-
<mxGeometry x="70" y="350" width="120" height="60" as="geometry"/>
73+
<mxGeometry x="179" y="340.5" width="120" height="60" as="geometry"/>
7174
</mxCell>
7275
<mxCell id="pFe5YTL7qQIc07WUC1TG-17" value="Lint/Test&lt;div&gt;source code&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
73-
<mxGeometry x="80" y="360" width="120" height="60" as="geometry"/>
76+
<mxGeometry x="179" y="360" width="120" height="60" as="geometry"/>
7477
</mxCell>
7578
<mxCell id="9" style="edgeStyle=orthogonalEdgeStyle;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;rounded=1;curved=0;" parent="1" source="2" target="pFe5YTL7qQIc07WUC1TG-10" edge="1">
7679
<mxGeometry relative="1" as="geometry"/>
@@ -122,6 +125,21 @@
122125
<mxCell id="22" value="CodeCoverage&lt;div&gt;75%&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#f8cecc;strokeColor=#b85450;" parent="1" vertex="1">
123126
<mxGeometry x="560" y="411" width="120" height="60" as="geometry"/>
124127
</mxCell>
128+
<mxCell id="23" value="Get settings&lt;div&gt;and test suites&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
129+
<mxGeometry x="29" y="303.5" width="120" height="60" as="geometry"/>
130+
</mxCell>
131+
<mxCell id="25" style="edgeStyle=orthogonalEdgeStyle;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;rounded=1;curved=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" edge="1" parent="1" source="23" target="pFe5YTL7qQIc07WUC1TG-1">
132+
<mxGeometry relative="1" as="geometry">
133+
<mxPoint x="570" y="367" as="targetPoint"/>
134+
<mxPoint x="319" y="400" as="sourcePoint"/>
135+
</mxGeometry>
136+
</mxCell>
137+
<mxCell id="26" style="edgeStyle=orthogonalEdgeStyle;html=1;rounded=1;curved=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="23" target="pFe5YTL7qQIc07WUC1TG-17">
138+
<mxGeometry relative="1" as="geometry">
139+
<mxPoint x="280" y="490" as="targetPoint"/>
140+
<mxPoint x="110" y="470" as="sourcePoint"/>
141+
</mxGeometry>
142+
</mxCell>
125143
</root>
126144
</mxGraphModel>
127145
</diagram>

media/Process-PSModule.png

33.7 KB
Loading

0 commit comments

Comments
 (0)