Skip to content

Commit 30be30e

Browse files
committed
added pipeline design
1 parent 5e6cec4 commit 30be30e

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,18 @@ A template repository for creating PowerShell modules with built-in CI/CD, testi
77
PSModuleTemplate provides a standardized structure for developing PowerShell modules with automated testing, building, and deployment workflows.
88
Use this template to quickly bootstrap new PowerShell module projects with industry-standard tooling and practices.
99

10+
## Pipeline Architecture
11+
12+
The CI/CD pipeline is split across three workflows triggered at different stages.
13+
14+
![Pipeline Architecture](assets/pipeline-architecture.png)
15+
16+
**Pull request** — opening a PR triggers two parallel jobs: integration tests (build + Pester) and the DocsBot which auto-generates markdown documentation for exported commands. Both must pass before the PR is ready to merge.
17+
18+
**Merge to main** — merging triggers the release pipeline which builds, tests, publishes to GitHub Packages, and creates a GitHub Release with the `.nupkg`, `.zip`, sha256 hashes, and auto-generated release notes. If GitHub Pages is enabled, the site is rebuilt automatically.
19+
20+
**Manual publish** — the PSGallery workflow is triggered manually from the Actions tab. It downloads the `.nupkg` from the latest GitHub Release and pushes it to the PowerShell Gallery.
21+
1022
## Features
1123

1224
- Pre-configured module structure

assets/pipeline-architecture.png

155 KB
Loading

0 commit comments

Comments
 (0)