Brownserve.PSTools 0.16.0-preview

Brownserve.PSTools

A collection of PowerShell tools that are used across various Brownserve projects to aid in CI/CD deployments and give an easy to maintain common codebase.
The tools are packaged as both a NuGet package and PSGallery PowerShell module for easy consumption across a wide variety of projects.

What's included?

Please see the module documentation for a full list of cmdlets and their usage.

How to use

ℹ Please Note
These tools have been designed for use within Brownserve projects and may have limited use outside of that.

If you simply want to have these tools available in your PowerShell session you can install the module from the PSGallery using Install-Module -Name Brownserve.PSTools.
To use these within a project you can use the Initialize-BrownserveRepository cmdlet which will initialize the repository with the required files and settings.

Contributing

Pull requests are welcome but please do bear in mind that these tools are designed specifically to work with Brownserve projects and are in use across various production CI/CD pipelines, therefore we may not be able to accommodate all requests.

Code should be written following our guidelines and should have complete documentation before being submitted (it will fail CI/CD if it doesn't). Documentation will be generated for you when you run the Build task locally however some sections will be missing and will need to be completed manually. For more information on how to build the module see the build documentation.

ℹ Please Note
Our branch protection rules require all commits to be signed.
While we can rebase and sign commits for you it's much more likely that your PR will be merged promptly if you ensure your commits are signed before submitting the PR.

We also try to use the Conventional Commits standard for our commit messages though this is not currently a hard requirement.