Skip to content

Commit dedfe9b

Browse files
docs(readme): update pipeline steps section for clarity and accuracy
1 parent 277785f commit dedfe9b

File tree

2 files changed

+6
-11
lines changed

2 files changed

+6
-11
lines changed

.github/workflows/workflow.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,6 @@ jobs:
484484
# - ✅ Merged PR - Publishes release when all tests/coverage/build succeed
485485
# - ✅ Abandoned PR - Publishes cleanup/retraction version
486486
# - ✅ Manual run - Publishes when all tests/coverage/build succeed
487-
#
488487
Publish-Module:
489488
if: |
490489
needs.Get-Settings.result == 'success' && !cancelled() && github.event_name == 'pull_request' && (

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -382,29 +382,25 @@ Runs [super-linter](https://github.com/super-linter/super-linter) to enforce cod
382382
Compiles each module by invoking [`PSModule/Build-PSModule`](https://github.com/PSModule/Build-PSModule).
383383
Supports script modules and manifest modules. Targets PowerShell 7.4+.
384384

385-
**Pipeline steps:**
385+
**What it does:**
386386

387387
1. Executes `*build.ps1` scripts alphabetically for preprocessing in `src/`.
388-
2. Copies `src/` into staging, skipping any existing root module.
389-
3. Builds the module manifest from data in `src/`.
388+
2. Builds the module manifest `<moduleName>.psd1` from data in `src/`.
390389
1. Uses the partial `src/manifest.psd1` if provided; otherwise creates new manifest.
391390
2. Sets baseline metadata: `RootModule`, `ModuleVersion`, `Author`, `CompanyName`, `Description`.
392391
3. Populates `FileList`, `ModuleList`, `RequiredAssemblies`, `NestedModules`, `ScriptsToProcess`, `TypesToProcess`,
393392
`FormatsToProcess`, `DscResourcesToExport`, and export lists.
394393
4. Gathers `#requires` statements to update `RequiredModules`, `PowerShellVersion`, `CompatiblePSEditions`.
395394
5. Derives `Tags`, `LicenseUri`, `ProjectUri`, `IconUri` from repository data.
396395
6. Preserves optional fields (`HelpInfoURI`, `ExternalModuleDependencies`, custom `PrivateData`).
397-
4. Composes root module `.psm1` from scripts, classes, variables, and support files.
398-
1. Adds `header.ps1` (when present) to the top of `<ModuleName>.psm1`.
399-
2. Injects a data loader so resources in `data/` become `$script:`-scoped variables.
396+
3. Composes root module `<moduleName>.psm1` from scripts, classes, variables, and support files in `src/`.
397+
1. Adds `header.ps1` (when present) to the top.
398+
2. Injects a data loader so `.psd1` files in `data/` become `$script:` scoped variables.
400399
3. Appends content from `init`, `classes/private`, `classes/public`, `functions/private`, `functions/public`,
401400
`variables/private`, `variables/public`, and root-level `*.ps1` files in alphabetical order.
402401
4. Registers public classes and enums using type accelerators.
403402
5. Emits trailing `Export-ModuleMember` statement exporting only members from `public` folders.
404-
5. Uploads `module` artifact and exposes `ModuleOutputFolderPath` for downstream jobs.
405-
406-
**Module manifest enrichment:**
407-
403+
4. Uploads `module` artifact and exposes `ModuleOutputFolderPath` for downstream jobs.
408404

409405
**References:**
410406

0 commit comments

Comments
 (0)