codacy-badger/pipelinesascode

The purpose of this library is to provide Azure DevOps pipeline administrators with a way to define and maintain both Build and Release Definitions with YML files for configuration/infrastructure as code.

Pipelines As Code

The purpose of this library is to provide Azure DevOps pipeline administrators with a way to define and maintain both Build and Release Definitions with YML files for configuration/infrastructure as code.

Prerequisites

• PowerShellGet
• Microsoft Account
• Azure DevOps Account
• Azure DevOps Project

2 Guides Available: Module Only or Full Project)

Getting Started - Module Only

These instructions will get you an updated copy of the module downloaded to your local machine and walk you through creating your first YML Build and Release Definitions!

Installation - Module Only

Install the latest version of the module from the PowerShell Gallery:

Install-Module PipelinesAsCode

Once you've installed this module to your local system you should be able to use the functions and commandlets provided:

Import-Module PipelinesAsCode

Get-Command -Module PipelinesAsCode

Getting Started - Full Project

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See Module Only section for notes on how to use the module on a live system.

Installation - Full Project

Step by step instructions for how to install this project and the required dependencies to your local machine

Install the latest version of the module from the PowerShell Gallery:

Install-Module PipelinesAsCode

Install Pester for running PowerShell unit tests from the PowerShell Gallery:

Install-Module Pester

Once you've installed these modules to your local system you should be able to use the functions and commandlets provided:

Import-Module Pester, PipelinesAsCode

Get-Command -Module Pester, PipelinesAsCode

Execute Tests

Once you have the project and Pester module installed, open PowerShell and navigate to the project directory:

Set-Location $HOME/source/repos/PipelinesAsCode

Once you have the test scripts pointed at your AzureDevOps instance you can go ahead and run the tests using Pester:

Invoke-Pester .\PipelinesAsCode.Tests.ps1

Development References

• Codecov.io - Code Coverage
• Codacy - Code Quality

Module References

• YamlDotNet - .NET library to help convert YML to PowerShell objects

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Nathan Duff - NateDuff