Getting Started with ModuleForge and Azure DevOps
This tutorial will demonstrate how to create a simple, single-function module using ModuleForge, with 1 pester test, and deploy via Azure DevOps Pipelines.
Part 0 - Local Environment Setup
- Make sure you have completed the prerequisit
- Setup your local workspace. You will need to have installed
- PowerShell 7.6+
- VSCode (or your IDE of choice)
- If you use an IDE other than VSCode, you will need to correct the instructions in this tutorial accordingly
- GIT commandline
- Install PowerShell module dependencies. You will need the following modules from the PSGallery:
Pester6.0+PSScriptAnalyzer1.25+Microsoft.PowerShell.PSResourceGet1.1.1+ (included with PowerShell 7.4 and newer)ModuleForge1.4.0+
Note: All the required modules are cross-platform compatible. Your OS of choice does not matter.
Here is a code-snippet to help get you started
Install-PSResource -repository PSGallery -Name Pester,PSScriptAnalyzer,ModuleForge
Part 1 - New Repository
- Login to your Azure DevOps project
- Select Repos from the left menu, then use the small down arrow at the top to select
New Repo - Fill in the Create a Repository menu
- Your new repository should be called
PSHelloWorld - You can leave the option for a readme selected
- You can leave .gitignore set to none
- Your new repository should be called
- Clone your repository to your local environment
hint: If you are unsure of how to clone a repository, copy the URI from the browser address bar and use it with the
git clonecommand, e.g.git clone https://dev.azure.com/AzureDevOps-OrgName/AzureDevOps-ProjectName/_git/AzureDevOps-RepoName
Part 2 - Create a new ModuleForge Project
- From your repository directory, run
New-MFProjectwith-Scaffold AzureDevOps, as per the example below. This builds the project files, and adds the Azure Pipelines YAML files and a PR template to the.azuredevopsdirectory, in one step - Check you have created a
sourcedirectory and a module config filemoduleForgeConfig.xml. The source directory should have a number of subfolders - Check the
.azuredevops/pipelinesdirectory was created. It has three active pipelines, for Pester testing, linting, and Build and Release. The files ending.exampleare optional extras you can enable later by renaming them - With your filestructure created and pipelines added, commit and sync your repository back to origin\main
- You should use a proper commit message, something like `chore: Initialised ModuleForge project with scaffolding & workflows’
New-MFProject -ModuleName 'psGetHelloWorld' -description 'Another Hello World module' -Scaffold AzureDevOps
Adding ModuleForge to an existing project, or already ran
New-MFProjectwithout-Scaffold? RunAdd-MFAzureDevOpsScaffoldto add the pipelines on their own.
Optional: Project Rules. Run
Add-MFProjectRulesbefore committing to add two ready-made rule sets, and enable the Project Rules pipeline (projectRules.yml). It checks your code runs under Constrained Language Mode, and that every public function has a help example, and posts its findings as an advisory PR comment. If you enable it, add it alongside the others in Part 3, as an Optional build policy. See Project Rules.
Part 3 - Add our Azure Pipelines and Build Policies
Note: The Pipeline setup and build policies steps need to be repeated for any new repositories
Adding Azure Pipelines
- Open Azure Devops in your browser and select Pipelines
- Select
New Pipelinein the top right of the Pipelines window. - In the connect tab, select
Azure Repos Gitas the option for where is your code - Select the correct repository
PSHelloWorld - In the Configure your Pipeline screen, select
Existing Azure Pipeline YAML file - Select the
psScriptAnalyzerLintReport.ymlfile - In the Review your Pipeline screen, use the small arrow next to RUN and select
SAVE - In the next screen, select the small three dot menu in the top-right, and select
Rename/Move - Change the name and folder of the pipeline
- The Name of the pipeline should be renamed to
psScriptAnalyzerLintReportto better identify it later - The
Select Foldershould be named after the repository -PSGetHelloWorld - This organisational step is critical to ensure that your Pipelines are well organised and identifiable later

- The Name of the pipeline should be renamed to
- Repeat steps 2 through to 9 for
buildAndReleaseandpesterTesting
- Name the
buildAndReleasepipeline Build and Release. The optional Build Test pipeline finds it by that name, so naming it now saves a step if you enable Build Test later. See Testing the Published Module - If you enabled Project Rules, repeat the steps for
projectRulestoo
Adding Branch Build Policies
- Go to your newly created Repo and select Branches option
- At the far right, when hovering over the main branch item, there will be a
More Optionsmenu. Open it, and select💡Branch policies - Under Build Validation, add a new item
- Point to the
psScriptAnalyzerpipeline we made in the previous section - Trigger should be
Automatic - Policy should be
Optional - Expiry can be left at default
- Change the displayname to
Script Analyzer Reportfor easier visualisation
- Point to the
- Under Build Validation, add a second new item
- Point to the
Pester Testingpipeline we made in the previous section - Trigger should be
Automatic - Policy should be
Required - Expiry can be left at default
- Change the displayname to
Pesterfor easier visualisation
- Point to the
- You should now have 2 Build Validation steps, 1 Optional Script Analyzer step, and 1 Required Pester step
Part 4 - Create a Function and a Test
If we did all the previous steps correctly, we should not need to do any more settings configurations for this repository.
Creating our get-helloWorld function
- Return to VSCode (or other IDE)
- Create a branch called
feature/hello-world-function.- You can deviate from this naming convention if you like. The objective is to be consistant.
- Create a new file in the
functionssub-directory of thesourcedirectory- Call the file
Get-HelloWorld.ps1
- Call the file
- Code up your powershell function code.
- An example is provided below
- Make sure you include some form of Inline Help and follow good coding practices
Hint: In VSCode you can create a branch by clicking on the current branch name in the bottom left corner, then in the dialog box, selecting
+Create New Branch. VSCode will automatically switch you to the new branch
function Get-HelloWorld
{
<#
.SYNOPSIS
Return Hello World
.DESCRIPTION
Return Hello World. Allows you to overwrite the default name of world with
.EXAMPLE
Get-HelloWorld
#### OUTPUT
Returns "Hello World!"
.EXAMPLE
Get-HelloWorld -name 'James'
#### OUTPUT
Returns "Hello James!"
#>
[CmdletBinding()]
PARAM(
#Name param, specify to override the default of World
[Parameter()]
[string]$Name = 'World'
)
begin{
#Return the script name when running verbose, makes it tidier
write-verbose "===========Executing $($MyInvocation.InvocationName)==========="
#Return the sent variables when running debug
Write-Debug "BoundParams: $($MyInvocation.BoundParameters|Out-String)"
}
process{
"Hello $Name!"
}
}
Creating our Pester Test
- Create a new file in the
functionssub-directory of thesourcedirectory- Call the file
Get-HelloWorld.Tests.ps1 - It is important that
Testsis in the correct, capital-case format forinvoke-pesterto work.
- Call the file
- Code up your Pester Test. You can use the example below
- Don’t forget to load your functions file in a before all block
- This can be achieved dynamically with this little piece of code:
. $PSCommandPath.Replace('.Tests.ps1','.ps1')
BeforeAll{
#Load The Function File
. $PSCommandPath.Replace('.Tests.ps1','.ps1')
}
Describe "Get-HelloWorld Default Parameters" {
BeforeAll {
$hello = Get-HelloWorld
}
It 'Should not be null or empty' {
$hello |Should -Not -BeNullOrEmpty
}
It 'Should contain "Hello World!"' {
$hello |Should -Be 'Hello World!'
}
}
Describe "Get-HelloWorld Custom Name" {
BeforeAll {
$hello = Get-HelloWorld -name 'James'
}
It 'Should not be null or empty' {
$hello |Should -Not -BeNullOrEmpty
}
It 'Should contain "Hello James!"' {
$hello |Should -Be 'Hello James!'
}
}
Run our Pester Test Locally
- It is a good idea to test locally before we submit our code back to the repository
- We can do that from our invoking pester from our working directory, as per below
- If everything is working as intended, you should have passed the 4 tests (represented in our Pester test as ‘It’ blocks)
Invoke-Pester '.\source\functions\Get-HelloWorld.Tests.ps1'

Part 5 - Pull Request and BuildAndRelease
Commit changes
- Commit just our functions file with the
featcommit prefix and a relevant comment- Something like
feat: added get-helloWorld function
- Something like
- Now commit the pester test file using the
testcommit prefix- Something like
test: added Pester testing for get-helloWorld
- Something like
- Publish your branch back to Azure DevOps
Hint: If you are not sure how to commit in VSCode, switch to the
Source Controlitem in the left-most menu. You will need to stage each file by clicking the small plus sign next the the filename. Enter the commit message into the text box labelled changes, when ready, hit commit. Once all your files are committed, you can publish your branch with thePublish Branchbutton that replaces theCommitbutton
Note: Don’t forget to checkout the Main branch on your local working directory before adding any more code.
Create a Pull request
- In your browser, navigate to your Azure DevOps project workspace and then repository and select the files Item. You should see a notification banner at the top advising that a new branch can be used to create a PR.
- Click the option to create a Pull Request
- Fill in the Pull Request template
- Type in a decent description
- Check the appropriate options with an
Xto help determine your next version, and to make it easier to review later. 
- Once you have completed the PR template, create the Pull Request
- On submission of a Pull Request to the Main branch, the Pester and ScriptAnalyzer workflows will automatically be invoked. The results will be added as comments to the PR
- If everything is tracking well, our tests passed, there are no merge conflicts, and we should be ok to proceed to
Merge Pull Request
If you want to explore your pester results in more details before a merge, you can click on
checksand review the pipeline results in details. You can also check out the Code-Coverage results that get added as part of the Pester Test step.
Build and Release
- With our Pull Request merged, navigate to
Pipelinesmenu - Find and select the
Build and Releasepipeline associated to your repository - Select the
Run Pipelineoption, a menu will appear. Fill out the fields appropriately and then chooserun workflow- Branch should be main
- Since this is our first release, lets leave the type to increment as
none - Type of release should be
prerelease - The
ModuleForgeversion should be stable - The feedname should match what you set in the PreRequisits
- If you changed the feedname, recommend you also update this form to reflect that change by editing the buildAndRelease.yml file

- Wait for our pipeline to finish.
- Browse to Artifacts and your Package Feed, where you can
If you want to
manuallydownload and install your new module, you can download the nupkg from the package feed, rename the extension to.zipand uncompress to find your module.
Part 6 - Install locally with PSresourceGet
Your module is now in your Azure Artifacts feed. To install it, you need a personal access token with only Packaging: Read, from User settings → Personal access tokens in Azure DevOps, and to register the feed once on your machine:
# Swap in your organization, project and feed. For an organization-scoped feed, leave out /<PROJECT_NAME>
Register-PSResourceRepository -Name 'myAzureDevopsFeed' -Uri 'https://pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/nuget/v3/index.json' -Trusted
# Any username, with the token as the password
$azdCredential = Get-Credential
# Your first build is a prerelease, so -Prerelease is needed to see it
Install-PSResource -Name psGetHelloWorld -Prerelease -Repository myAzureDevopsFeed -Credential $azdCredential
Using Private Package Feeds covers the rest: storing the credential in a secret vault so you don’t pass it each time, and the quirks worth knowing, such as no wildcard searches. Microsoft’s private PowerShell library tutorial has more on Azure Artifacts itself.
Wrapping up
In this tutorial, we created a new repository, added our ModuleForge scaffolding, created a new PowerShell function + test, performed a review and unit test, and released it as a PreRelease into our private Azure DevOps Packages feed for consumption. We effectively made a CI/CD PowerShell Pipeline using Azure DevOps Pipelines + ModuleForge, and published a single-function module.
Next, Making the Most of Releases explains which Build and Release options to pick as your module grows.







