Skip to content

Commit 8c0220a

Browse files
feat: add scenario matrix to README for job execution based on trigger scenarios
1 parent 7be2509 commit 8c0220a

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,32 @@ Depending on the labels in the pull requests, the workflow will result in differ
6868
- Publishes the module to the PowerShell Gallery.
6969
- Creates a release on the GitHub repository.
7070

71+
### Scenario Matrix
72+
73+
This table shows when each job runs based on the trigger scenario:
74+
75+
| Job | Open/Updated PR | Merged PR | Abandoned PR | Manual Run |
76+
|-----|-----------------|-----------|--------------|------------|
77+
| **Get-Settings** | ✅ Always | ✅ Always | ✅ Always | ✅ Always |
78+
| **Lint-Repository** | ✅ Yes | ❌ No | ❌ No | ❌ No |
79+
| **Build-Module** | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes |
80+
| **Build-Docs** | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes |
81+
| **Build-Site** | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes |
82+
| **Test-SourceCode** | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes |
83+
| **Lint-SourceCode** | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes |
84+
| **Test-Module** | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes |
85+
| **BeforeAll-ModuleLocal** | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes |
86+
| **Test-ModuleLocal** | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes |
87+
| **AfterAll-ModuleLocal** | ✅ Yes | ✅ Yes | ✅ Yes* | ✅ Yes |
88+
| **Get-TestResults** | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes |
89+
| **Get-CodeCoverage** | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes |
90+
| **Publish-Site** | ❌ No | ✅ Yes | ❌ No | ❌ No |
91+
| **Publish-Module** | ✅ Yes** | ✅ Yes** | ✅ Yes*** | ✅ Yes** |
92+
93+
\* Runs for cleanup if tests were started
94+
\*\* Only when all tests/coverage/build succeed
95+
\*\*\* Publishes cleanup/retraction version
96+
7197
To use the workflow, create a new file in the `.github/workflows` directory of the module repository and add the following content.
7298

7399
<details>

0 commit comments

Comments
 (0)