Getting Started

Getting Started

Prerequisites

• A PowerShell module repository based on Sampler.
• PowerShell 7 or Windows PowerShell 5.1.
• Access to a PowerShell Universal server for deployment tasks.
• A PowerShell Universal application token for authenticated deployments.

Install the task module

Add the module to the consumer repository's RequiredModules.psd1:

@{
    Sampler.PowerShellUniversalTasks = 'latest'
}

For released versions, the module can also be installed directly:

Install-PSResource -Name Sampler.PowerShellUniversalTasks

Import the task file

Add the module to ModuleBuildTasks in the consumer repository's build.yaml:

ModuleBuildTasks:
  Sampler.PowerShellUniversalTasks:
    - 'Task.*'

Sampler imports the module and dot-sources the task file through the exported Task.Publish_PowerShellUniversal alias.

Configure the server

Add a UniversalServer section:

UniversalServer:
  UniversalServerUrl: https://psu.example.test
  UniversalPSResourceRepositoryName: output
  UniversalPSResourceRepositoryUrl: ./output/
  UniversalPSResourceRepositoryAutoRemove: true
  UniversalRepositoryStagingDirectoryName: PsuRepository
  UniversalRepositoryAsModule: false
  UniversalUnpinned: true

Do not store UniversalServerAppToken in build.yaml. Supply it as an environment variable in CI:

$env:UniversalServerAppToken = '<token>'

For local development, the tasks also dot-source secrets.local.ps1 from the consumer repository root when that ignored file exists:

$UniversalServerAppToken = '<token>'

Add workflows

Package and deploy the module directly:

BuildWorkflow:
  pack:
    - build
    - package_module_nupkg

  deploy:
    - pack
    - publish_packed_module_to_universal_server

Package and deploy a complete offline automation repository:

BuildWorkflow:
  pack:
    - build
    - package_module_nupkg
    - package_universal_automation_repository

  deploy_repository:
    - pack
    - publish_universal_automation_repository_to_server

Run workflows through the Sampler entry point:

./build.ps1 -Tasks pack
./build.ps1 -Tasks deploy_repository

Review Configuration before deployment and Task Reference for task prerequisites and output details.