Skip to content

Commit 49dfea7

Browse files
MariusStorhaugMariusStorhaug
committed
fix(workflow): clean up commented job descriptions in workflow file
1 parent 8b2d083 commit 49dfea7

File tree

1 file changed

+60
-60
lines changed

1 file changed

+60
-60
lines changed

‎.github/workflows/workflow.yml‎

Lines changed: 60 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,10 @@ permissions:
7272

7373
jobs:
7474
# Runs on:
75-
# - ✅ Open/Updated PR - Always runs to load configuration
76-
# - ✅ Merged PR - Always runs to load configuration
77-
# - ✅ Abandoned PR - Always runs to load configuration
78-
# - ✅ Manual run - Always runs to load configuration
75+
# - ✅ Open/Updated PR - Always runs to load configuration
76+
# - ✅ Merged PR - Always runs to load configuration
77+
# - ✅ Abandoned PR - Always runs to load configuration
78+
# - ✅ Manual run - Always runs to load configuration
7979
Get-Settings:
8080
uses: ./.github/workflows/Get-Settings.yml
8181
with:
@@ -88,10 +88,10 @@ jobs:
8888
WorkingDirectory: ${{ inputs.WorkingDirectory }}
8989

9090
# Runs on:
91-
# - ✅ Open/Updated PR - Lints code changes in active PRs
92-
# - ❌ Merged PR - No need to lint after merge + its a merge commit that causes issues with super-linter
93-
# - ❌ Abandoned PR - No need to lint abandoned changes
94-
# - ❌ Manual run - Only runs for PR events
91+
# - ✅ Open/Updated PR - Lints code changes in active PRs
92+
# - ❌ Merged PR - No need to lint after merge + its a merge commit that causes issues with super-linter
93+
# - ❌ Abandoned PR - No need to lint abandoned changes
94+
# - ❌ Manual run - Only runs for PR events
9595
Lint-Repository:
9696
name: Lint code base
9797
runs-on: ubuntu-latest
@@ -117,10 +117,10 @@ jobs:
117117
VALIDATE_YAML_PRETTIER: false
118118

119119
# Runs on:
120-
# - ✅ Open/Updated PR - Builds module for testing
121-
# - ✅ Merged PR - Builds module for publishing
122-
# - ❌ Abandoned PR - Skips building abandoned changes
123-
# - ✅ Manual run - Builds module when manually triggered
120+
# - ✅ Open/Updated PR - Builds module for testing
121+
# - ✅ Merged PR - Builds module for publishing
122+
# - ❌ Abandoned PR - Skips building abandoned changes
123+
# - ✅ Manual run - Builds module when manually triggered
124124
Build-Module:
125125
if: ${{ !(github.event.action == 'closed' && github.event.pull_request.merged != true) && fromJson(needs.Get-Settings.outputs.Settings).Build.Module.Skip != true }}
126126
uses: ./.github/workflows/Build-Module.yml
@@ -131,10 +131,10 @@ jobs:
131131
WorkingDirectory: ${{ inputs.WorkingDirectory }}
132132

133133
# Runs on:
134-
# - ✅ Open/Updated PR - Builds documentation for review
135-
# - ✅ Merged PR - Builds documentation for publishing
136-
# - ❌ Abandoned PR - Skips building docs for abandoned changes
137-
# - ✅ Manual run - Builds documentation when manually triggered
134+
# - ✅ Open/Updated PR - Builds documentation for review
135+
# - ✅ Merged PR - Builds documentation for publishing
136+
# - ❌ Abandoned PR - Skips building docs for abandoned changes
137+
# - ✅ Manual run - Builds documentation when manually triggered
138138
Build-Docs:
139139
if: ${{ !(github.event.action == 'closed' && github.event.pull_request.merged != true) && fromJson(needs.Get-Settings.outputs.Settings).Build.Docs.Skip != true }}
140140
needs:
@@ -150,10 +150,10 @@ jobs:
150150
WorkingDirectory: ${{ inputs.WorkingDirectory }}
151151

152152
# Runs on:
153-
# - ✅ Open/Updated PR - Builds site for preview
154-
# - ✅ Merged PR - Builds site for publishing
155-
# - ❌ Abandoned PR - Skips building site for abandoned changes
156-
# - ✅ Manual run - Builds site when manually triggered
153+
# - ✅ Open/Updated PR - Builds site for preview
154+
# - ✅ Merged PR - Builds site for publishing
155+
# - ❌ Abandoned PR - Skips building site for abandoned changes
156+
# - ✅ Manual run - Builds site when manually triggered
157157
Build-Site:
158158
if: ${{ !(github.event.action == 'closed' && github.event.pull_request.merged != true) && fromJson(needs.Get-Settings.outputs.Settings).Build.Site.Skip != true }}
159159
needs:
@@ -169,10 +169,10 @@ jobs:
169169
WorkingDirectory: ${{ inputs.WorkingDirectory }}
170170

171171
# Runs on:
172-
# - ✅ Open/Updated PR - Tests source code changes
173-
# - ✅ Merged PR - Tests source code before publishing
174-
# - ❌ Abandoned PR - Skips testing abandoned changes
175-
# - ✅ Manual run - Tests source code when manually triggered
172+
# - ✅ Open/Updated PR - Tests source code changes
173+
# - ✅ Merged PR - Tests source code before publishing
174+
# - ❌ Abandoned PR - Skips testing abandoned changes
175+
# - ✅ Manual run - Tests source code when manually triggered
176176
Test-SourceCode:
177177
if: ${{ !(github.event.action == 'closed' && github.event.pull_request.merged != true) && needs.Get-Settings.outputs.SourceCodeTestSuites != '[]' }}
178178
needs:
@@ -193,10 +193,10 @@ jobs:
193193
WorkingDirectory: ${{ inputs.WorkingDirectory }}
194194

195195
# Runs on:
196-
# - ✅ Open/Updated PR - Lints source code changes
197-
# - ✅ Merged PR - Lints source code before publishing
198-
# - ❌ Abandoned PR - Skips linting abandoned changes
199-
# - ✅ Manual run - Lints source code when manually triggered
196+
# - ✅ Open/Updated PR - Lints source code changes
197+
# - ✅ Merged PR - Lints source code before publishing
198+
# - ❌ Abandoned PR - Skips linting abandoned changes
199+
# - ✅ Manual run - Lints source code when manually triggered
200200
Lint-SourceCode:
201201
if: ${{ !(github.event.action == 'closed' && github.event.pull_request.merged != true) && needs.Get-Settings.outputs.SourceCodeTestSuites != '[]' }}
202202
needs:
@@ -217,10 +217,10 @@ jobs:
217217
WorkingDirectory: ${{ inputs.WorkingDirectory }}
218218

219219
# Runs on:
220-
# - ✅ Open/Updated PR - Tests built module
221-
# - ✅ Merged PR - Tests built module before publishing
222-
# - ❌ Abandoned PR - Skips testing abandoned changes
223-
# - ✅ Manual run - Tests built module when manually triggered
220+
# - ✅ Open/Updated PR - Tests built module
221+
# - ✅ Merged PR - Tests built module before publishing
222+
# - ❌ Abandoned PR - Skips testing abandoned changes
223+
# - ✅ Manual run - Tests built module when manually triggered
224224
Test-Module:
225225
if: ${{ !(github.event.action == 'closed' && github.event.pull_request.merged != true) && needs.Build-Module.result == 'success' && !cancelled() && needs.Get-Settings.outputs.PSModuleTestSuites != '[]' }}
226226
needs:
@@ -243,10 +243,10 @@ jobs:
243243
WorkingDirectory: ${{ inputs.WorkingDirectory }}
244244

245245
# Runs on:
246-
# - ✅ Open/Updated PR - Runs setup scripts before local module tests
247-
# - ✅ Merged PR - Runs setup scripts before local module tests
248-
# - ❌ Abandoned PR - Skips setup for abandoned changes
249-
# - ✅ Manual run - Runs setup scripts when manually triggered
246+
# - ✅ Open/Updated PR - Runs setup scripts before local module tests
247+
# - ✅ Merged PR - Runs setup scripts before local module tests
248+
# - ❌ Abandoned PR - Skips setup for abandoned changes
249+
# - ✅ Manual run - Runs setup scripts when manually triggered
250250
BeforeAll-ModuleLocal:
251251
if: ${{ !(github.event.action == 'closed' && github.event.pull_request.merged != true) && needs.Build-Module.result == 'success' && !cancelled() && needs.Get-Settings.outputs.ModuleTestSuites != '[]' }}
252252
name: BeforeAll-ModuleLocal
@@ -292,10 +292,10 @@ jobs:
292292
}
293293
294294
# Runs on:
295-
# - ✅ Open/Updated PR - Tests module in local environment
296-
# - ✅ Merged PR - Tests module in local environment before publishing
297-
# - ❌ Abandoned PR - Skips testing abandoned changes
298-
# - ✅ Manual run - Tests module in local environment when manually triggered
295+
# - ✅ Open/Updated PR - Tests module in local environment
296+
# - ✅ Merged PR - Tests module in local environment before publishing
297+
# - ❌ Abandoned PR - Skips testing abandoned changes
298+
# - ✅ Manual run - Tests module in local environment when manually triggered
299299
Test-ModuleLocal:
300300
if: ${{ !(github.event.action == 'closed' && github.event.pull_request.merged != true) && needs.Build-Module.result == 'success' && !cancelled() && needs.Get-Settings.outputs.ModuleTestSuites != '[]' }}
301301
needs:
@@ -321,10 +321,10 @@ jobs:
321321
WorkingDirectory: ${{ inputs.WorkingDirectory }}
322322

323323
# Runs on:
324-
# - ✅ Open/Updated PR - Runs teardown scripts after local module tests
325-
# - ✅ Merged PR - Runs teardown scripts after local module tests
326-
# - ✅ Abandoned PR - Runs teardown if tests were started (cleanup)
327-
# - ✅ Manual run - Runs teardown scripts after local module tests
324+
# - ✅ Open/Updated PR - Runs teardown scripts after local module tests
325+
# - ✅ Merged PR - Runs teardown scripts after local module tests
326+
# - ✅ Abandoned PR - Runs teardown if tests were started (cleanup)
327+
# - ✅ Manual run - Runs teardown scripts after local module tests
328328
AfterAll-ModuleLocal:
329329
if: ${{ needs.Test-ModuleLocal.result != 'skipped' && always() }}
330330
name: AfterAll-ModuleLocal
@@ -370,10 +370,10 @@ jobs:
370370
}
371371
372372
# Runs on:
373-
# - ✅ Open/Updated PR - Collects and reports test results
374-
# - ✅ Merged PR - Collects and reports test results before publishing
375-
# - ❌ Abandoned PR - Skips collecting results for abandoned changes
376-
# - ✅ Manual run - Collects and reports test results when manually triggered
373+
# - ✅ Open/Updated PR - Collects and reports test results
374+
# - ✅ Merged PR - Collects and reports test results before publishing
375+
# - ❌ Abandoned PR - Skips collecting results for abandoned changes
376+
# - ✅ Manual run - Collects and reports test results when manually triggered
377377
Get-TestResults:
378378
if: ${{ !(github.event.action == 'closed' && github.event.pull_request.merged != true) && needs.Get-Settings.result == 'success' && !fromJson(needs.Get-Settings.outputs.Settings).Test.TestResults.Skip && (needs.Get-Settings.outputs.SourceCodeTestSuites != '[]' || needs.Get-Settings.outputs.PSModuleTestSuites != '[]' || needs.Get-Settings.outputs.ModuleTestSuites != '[]') && (always() && !cancelled()) }}
379379
needs:
@@ -394,10 +394,10 @@ jobs:
394394
Version: ${{ inputs.Version }}
395395

396396
# Runs on:
397-
# - ✅ Open/Updated PR - Calculates and reports code coverage
398-
# - ✅ Merged PR - Calculates and reports code coverage before publishing
399-
# - ❌ Abandoned PR - Skips coverage for abandoned changes
400-
# - ✅ Manual run - Calculates and reports code coverage when manually triggered
397+
# - ✅ Open/Updated PR - Calculates and reports code coverage
398+
# - ✅ Merged PR - Calculates and reports code coverage before publishing
399+
# - ❌ Abandoned PR - Skips coverage for abandoned changes
400+
# - ✅ Manual run - Calculates and reports code coverage when manually triggered
401401
Get-CodeCoverage:
402402
if: ${{ !(github.event.action == 'closed' && github.event.pull_request.merged != true) && needs.Get-Settings.result == 'success' && !fromJson(needs.Get-Settings.outputs.Settings).Test.CodeCoverage.Skip && (needs.Get-Settings.outputs.PSModuleTestSuites != '[]' || needs.Get-Settings.outputs.ModuleTestSuites != '[]') && (always() && !cancelled()) }}
403403
needs:
@@ -415,10 +415,10 @@ jobs:
415415
Version: ${{ inputs.Version }}
416416

417417
# Runs on:
418-
# - ❌ Open/Updated PR - Site not published for PRs in progress
419-
# - ✅ Merged PR - Deploys site to GitHub Pages after successful merge
420-
# - ❌ Abandoned PR - Site not published for abandoned changes
421-
# - ❌ Manual run - Only publishes on merged PRs, not manual runs
418+
# - ❌ Open/Updated PR - Site not published for PRs in progress
419+
# - ✅ Merged PR - Deploys site to GitHub Pages after successful merge
420+
# - ❌ Abandoned PR - Site not published for abandoned changes
421+
# - ❌ Manual run - Only publishes on merged PRs, not manual runs
422422
Publish-Site:
423423
if: ${{ !(github.event.action == 'closed' && github.event.pull_request.merged != true) && needs.Get-TestResults.result == 'success' && needs.Get-CodeCoverage.result == 'success' && needs.Build-Site.result == 'success' && !cancelled() && github.event_name == 'pull_request' && github.event.pull_request.merged == true }}
424424
needs:
@@ -441,10 +441,10 @@ jobs:
441441
uses: actions/deploy-pages@v4
442442

443443
# Runs on:
444-
# - ✅ Open/Updated PR - Publishes prerelease when all tests/coverage/build succeed
445-
# - ✅ Merged PR - Publishes release when all tests/coverage/build succeed
446-
# - ✅ Abandoned PR - Publishes cleanup/retraction version
447-
# - ✅ Manual run - Publishes when all tests/coverage/build succeed
444+
# - ✅ Open/Updated PR - Publishes prerelease when all tests/coverage/build succeed
445+
# - ✅ Merged PR - Publishes release when all tests/coverage/build succeed
446+
# - ✅ Abandoned PR - Publishes cleanup/retraction version
447+
# - ✅ Manual run - Publishes when all tests/coverage/build succeed
448448
#
449449
Publish-Module:
450450
if: |

0 commit comments

Comments
 (0)