build.yaml

---
####################################################
#          ModuleBuilder Configuration             #
####################################################
# Path to the Module Manifest to build (where path will be resolved from)
# SourcePath: ./Sampler/Sampler.psd1
# Output Directory where ModuleBuilder will build the Module, relative to module manifest
# OutputDirectory: ../output/Sampler
BuiltModuleSubdirectory: module
CopyPaths:
  - en-US
  - Tasks
#  - DSCResources
  # - Modules
Encoding: UTF8
# Can be used to manually specify module's semantic version if the preferred method of
# using GitVersion is not available, and it is not possible to set the session environment
# variable `$env:ModuleVersion`, nor setting the variable `$ModuleVersion`, in the
# PowerShell session (parent scope) before running the task `build`.
#SemVer: '99.0.0-preview1'

# suffix: suffix.ps1
prefix: prefix.ps1
VersionedOutputDirectory: true

AliasesToExport:
  - 'Task.Publish_PowerShellUniversal'

####################################################
#      ModuleBuilder Submodules Configuration      #
####################################################

NestedModule:
#  HelperSubmodule: # This is the first submodule to build into the output
#    Path: ./*/Modules/HelperSubmodule/HelperSubmodule.psd1
#    #  is trimmed (remove metadata & Prerelease tag) and OutputDirectory expanded (the only one)
#    OutputDirectory: ///Modules/HelperSubmodule
#    VersionedOutputDirectory: false
#    AddToManifest: false
#    SemVer: 
#    # suffix:
#    # prefix:

####################################################
#       Sampler Pipeline Configuration             #
####################################################
# Defining 'Workflows' (suite of InvokeBuild tasks) to be run using their alias
BuildWorkflow:
  '.': # "." is the default Invoke-Build workflow. It is called when no -Tasks is specified to the build.ps1
    - build
    - test

  build:
    - Clean
    - Build_Module_ModuleBuilder
    - Build_NestedModules_ModuleBuilder
    - Create_changelog_release_output

  docs:
    - Create_Wiki_Output_Folder
    - Generate_Markdown_For_Public_Commands
    - Generate_External_Help_File_For_Public_Commands
    - Clean_Markdown_Of_Public_Commands
    - Copy_Source_Wiki_Folder
    - Generate_Wiki_Sidebar
    - Clean_Markdown_Metadata
    - Package_Wiki_Content

  pack:
    - build
    - docs
    - package_module_nupkg

  hqrmtest:
    - Invoke_HQRM_Tests_Stop_On_Fail

  # Defining test task to be run when invoking `./build.ps1 -Tasks test`
  test:
    # Uncomment to modify the PSModulePath in the test pipeline (also requires the build configuration section SetPSModulePath).
    #- Set_PSModulePath
    - Pester_Tests_Stop_On_Fail
    # Use this task if pipeline uses code coverage and the module is using the
    # pattern of Public, Private, Enum, Classes.
    #- Convert_Pester_Coverage
    - Pester_if_Code_Coverage_Under_Threshold

  # Use this task when you have multiple parallel tests, which produce multiple
  # code coverage files and needs to get merged into one file.
  #merge:
    #- Merge_CodeCoverage_Files

  publish:
    - Publish_Release_To_GitHub # Runs first, if token is expired it will fail early
    - publish_module_to_gallery
    - Publish_GitHub_Wiki_Content

####################################################
#              PESTER Configuration                #
####################################################

Pester:
  # Pester Advanced configuration.
  # If a key is not set it will be using Sampler pipeline default value.
  Configuration:
    Run:
      # If no scripts are defined the default is to use all the tests under the project's
      # tests folder or source folder (if present). Test script paths can be defined to
      # only run tests in certain folders, or run specific test files, or can be use to
      # specify the order tests are run.
      Path:
        #- tests/QA/module.tests.ps1
        #- tests/QA
        #- tests/Unit
        #- tests/Integration
    Output:
      Verbosity: Detailed
      StackTraceVerbosity: Full
      CIFormat: Auto
    Filter:
      Tag:
      ExcludeTag:
        #- helpQuality
        #- FunctionalQuality
        #- TestQuality
    CodeCoverage:
      CoveragePercentTarget: 0 # Set to 0 to bypass
      #OutputPath: JaCoCo_$OsShortName.xml
      #OutputEncoding: ascii
      UseBreakpoints: false
    TestResult:
      OutputFormat: NUnitXML
      OutputEncoding: ascii
  # Will look at every *.ps1 & *.psm1 under ModulePath, excepts when $_.FullName -match (Join-Path $ProjectPath $ExcludeFromCodeCoverageItem)
  ExcludeFromCodeCoverage:
    - Tasks


# Use this if code coverage should be merged from several pipeline test jobs.
# Any existing keys above should be replaced. See also CodeCoverage below.
# Pester.Configuration.CodeCoverage.OutputPath is the file that is created for
# each pipeline test job.
#OutputPath: JaCoCo_Merge.xml

# Use this to merged code coverage from several pipeline test jobs.
# CodeCoverageFilePattern      - the pattern used to search all pipeline test job artifacts
#                                after the file specified in CodeCoverage.OutputPath above.
# CodeCoverageMergedOutputFile - the file that is created by the merge build task and
#                                is the file that should be uploaded to code coverage services.
#CodeCoverage:
  #CodeCoverageFilePattern: JaCoCo_Merge.xml # the pattern used to search all pipeline test job artifacts
  #CodeCoverageMergedOutputFile: JaCoCo_coverage.xml # the file that is created for the merged code coverage

DscTest:
  Pester:
    Configuration:
      Filter:
        ExcludeTag:
          - "Common Tests - New Error-Level Script Analyzer Rules"
          - "Common Tests - Validate Localization"
          - "BuiltModule Tests - Validate Localization"
          - "Common Tests - Validate Example Files To Be Published"
          - "Common Tests - Validate Example Files"
          - "Common Tests - Required Script Analyzer Rules"
      Output:
        Verbosity: Detailed
        CIFormat: Auto
      TestResult:
        Enabled: true
        OutputFormat: NUnitXML
        OutputEncoding: ascii
        OutputPath: ./output/testResults/NUnitXml_HQRM_Tests.xml
  Script:
    ExcludeSourceFile:
      - output
    ExcludeModuleFile:
      - Modules/DscResource.Common
    MainGitBranch: main

# Import ModuleBuilder tasks from a specific PowerShell module using the build
# task's alias. Wildcard * can be used to specify all tasks that has a similar
# prefix and or suffix. The module contain the task must be added as a required
# module in the file RequiredModules.psd1.
ModuleBuildTasks:
  Sampler:
    - '*.build.Sampler.ib.tasks'
  Sampler.GitHubTasks:
    - '*.ib.tasks'
  DscResource.Test:
    - 'Task.*'
  DscResource.DocGenerator:
    - 'Task.*'


# Invoke-Build Header to be used to 'decorate' the terminal output of the tasks.
TaskHeader: |
  param($Path)
  ""
  "=" * 79
  Write-Build Cyan "`t`t`t$($Task.Name.replace("_"," ").ToUpper())"
  Write-Build DarkGray  "$(Get-BuildSynopsis $Task)"
  "-" * 79
  Write-Build DarkGray "  $Path"
  Write-Build DarkGray "  $($Task.InvocationInfo.ScriptName):$($Task.InvocationInfo.ScriptLineNumber)"
  ""


####################################################
#             Git Configuration                    #
####################################################
GitConfig:
  # UserName: dscbot
  # UserEmail: dsccommunity@outlook.com
  MainGitBranch: main

GitHubConfig:
  GitHubFilesToAdd:
    - CHANGELOG.md
  ReleaseAssets:
    - output/CHANGELOG.md
    - output/WikiContent.zip
  GitHubConfigUserName: github-actions[bot]
  GitHubConfigUserEmail: 41898282+github-actions[bot]@users.noreply.github.com
  UpdateChangelogOnPrerelease: false

####################################################
#      DscResource.DocGenerator Configuration      #
####################################################
DscResource.DocGenerator:
  Publish_GitHub_Wiki_Content:
    Debug: false
  Generate_Wiki_Sidebar:
    Debug: false
    AlwaysOverwrite: true

####################################################
#          Changelog Configuration                 #
####################################################
# Used by Create_Changelog_Branch task. Defaults are shown below.
# ChangelogConfig:
#   FilesToAdd:
#     - 'CHANGELOG.md'
#   UpdateChangelogOnPrerelease: false  # Set to true to update changelog on pre-releases too