Stucco
GitHub Actions | PS Gallery | License |
---|---|---|
Stucco is an opinionated Plaster template for building high-quality PowerShell modules. This template produces PowerShell projects according to a structure that I and many others in the PowerShell community use. Apart from the PowerShell module itself, this template creates project scaffolding that enables effective collaboration with the community.
Features
- MIT or Apache licensing options
- Changelog following Keep a Changelog guidelines with Semantic Versioning
- Optional Code of Conduct
- Optional Read The Docs support for online documentation using Mkdocs
- Optional PlatyPS support for markdown-based help documentation
- Project dependency resolution using PSDepend
- psake tasks using PowerShellBuild for build / test automation
- AppVeyor, Azure Pipelines or GitLab CI/CD for CI/CD
- GitHub templates for contributing, issues, and pull requests
- VSCode tasks
Usage
$template = Get-PlasterTemplate -IncludeInstalledModules | Where-Object TemplatePath -Match 'Stucco'
Invoke-Plaster -TemplatePath $template.TemplatePath
Contributions Welcome
The goal of this project is help create common patterns for PowerShell module development. Additional features or capabilities that benefit the community are welcome.