Skip to content

Brownserve.PSBuildTools Module

Description

A collection of PowerShell build tools used across various Brownserve projects to aid in CI/CD deployments and module development.

Brownserve.PSBuildTools Cmdlets

Add-BrownserveChangelogEntry

Inserts a new changelog entry into a given changelog file

Add-ModuleHelp

Creates XML MALM help for a PowerShell module

Build-ModuleDocumentation

This will build markdown PowerShell module documentation using PlatyPS

Format-NuGetPackageVersion

Formats a version number to ensure compatibility with NuGet and nuget.org

Get-BrownserveRepositoryPaths

Returns a list of all paths that are managed for a given repository.

Get-SPDXLicenseIDs

Attempts to get the latest SPDX license short ID list.

Import-PlatyPSModule

Imports the PlatyPS module avoiding collisions with other modules.

Initialize-BrownserveRepository

Prepares a repository for use for a given project

New-BrownserveChangelogEntry

Creates a new Keep a Changelog entry for a given version in the standard Brownserve format.

New-BrownservePowerShellModule

Creates a new PowerShell module in the standard Brownserve format

New-BrownservePowerShellModuleBuild

Adds the various requirements to build a PowerShell module to a given project/repo.

New-SPDXLicense

Creates a new licence using the SPDX format

Read-BrownserveChangelog

Reads in a changelog file and returns the contents as a custom object.

Send-BuildNotification

Sends a standard Brownserve build notification.

Send-SlackNotification

Sends a notification to a given Slack webhook

Update-BrownservePowerShellModule

Updates a given Brownserve PowerShell module to use the latest template.

Update-BrownserveRepository

Updates a given repository to use the latest tooling and settings

Update-Version

A simple function to increment a semantic version number.