README.md

PSBuildRelease

Generic InvokeBuild tasks used during PowerShell module development.

• PSBuildRelease
  • Installation
    • Prerequisites
    • Module Structure
  • Usage
    • Azure DevOps
    • Locally
  • Contributing

Installation

To properly make use of these task you need to make sure your code follows a few guidelines.

Prerequisites

• PSDepend
• Pester
• InvokeBuild
• BuildQualityChecks (Azure Devops Task)
• GitVersion (Azure Devops Task)
• BuildHelpers
• GitVersion (Optional)
• PowerShell Core (For building locally)

Module Structure

+── src
│   +── classes  (Optional)
│   │   +── *.psm1
│   +── private (Optional)
│   │   +── *.ps1
│   +── public (Optional)
│   │   +── *.ps1
+── tests (Optional)
+── Manifest.json
+── azure-pipelines.yml
+── GitVersion.yml (Optional)
+── .build.ps1
+── PSDepend.build.psd1

Check the template files contained in this repository for help.

Usage

Azure DevOps

After configuring according to Installation run your Azure Pipelines build process.

Locally

To build locally you will require PowerShell Core. This has no impact on the actual usage of the module or the tests, but it required for things such as semanticversioning class, New-ModuleManifest improvements etc.

Invoke-Build -Tasks CreateModuleManifest, DownloadDependentModules -ResolveDependency

Once the module is built, you can run the tests in either PowerShell Core or WinPS as necessary.

Invoke-Build -Tasks Test

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.