PowerShell Modules#

A PowerShell module is a distributable package of functions, cmdlets, and scripts built to be shared and reused across environments. Modules are published to and installed from the PowerShell Gallery, the official repository for PowerShell packages. See the official PowerShell modules documentation.

Modules are the primary unit of reusable automation in the PowerShell ecosystem. Packaging logic into versioned, tested, and published modules keeps pipelines maintainable and composable — any team or workflow can consume shared functions without copying code. Strong module conventions make the public API surface explicit, so breaking changes are intentional and versioned correctly through SemVer.

Getting started#

Create a repo from Template-PSModule, then follow the setup steps in the Process-PSModule README.

The template ships with placeholder files to illustrate the expected layout — remove them all on the initial commit before writing real code:

• README.md — replace {{ NAME }} and {{ DESCRIPTION }} with real content
• examples/General.ps1 — replace with a real usage example
• src/functions/public/PSModule/ — placeholder group folder; delete the entire folder
• src/functions/public/SomethingElse/ — placeholder group folder; delete the entire folder
• src/functions/public/Test-PSModuleTest.ps1 — placeholder function; delete
• src/functions/public/completers.ps1 — placeholder argument completer; delete unless needed
• tests/PSModuleTest.Tests.ps1 — placeholder tests; delete

Version increments are driven by PR labels (Major, Minor, Patch, Prerelease), and the RepoType: Module custom property integrates each repository with organization-wide tooling.

• Standards — Repository layout, naming, style, parameter design, comment-based help, and SOLID applied to PowerShell modules.
• Test Specification — How we write Pester tests: structure, hierarchy, and naming conventions.
• Versioning — How changes to the public interface determine the SemVer version bump.

What we have delivered#