CI build for v2 branch

.ci/ci.yml

@@ -0,0 +1,92 @@
+name: Build-$(System.PullRequest.PullRequestNumber)-$(Date:yyyyMMdd)$(Rev:.rr)
+trigger:
+ # Batch merge builds together while a merge build is running
+ batch: true
+ branches:
+ include:
+ - master
+ - release/*
+pr:
+ branches:
+ include:
+ - master
+ - release/*
+
+resources:
+ repositories:
+ - repository: ComplianceRepo
+ type: github
+ endpoint: ComplianceGHRepo
+ name: PowerShell/Compliance
+
+stages:
+- stage: Build
+ displayName: Build PowerShell Package
+ jobs:
+ - job: BuildPkg
+ displayName: Build Package
+ pool:
+ vmImage: windows-latest
+ steps:
+ - pwsh: |
+ $(Build.SourcesDirectory)/build.ps1 -Clean
+ displayName: Build
+
+ - pwsh: |
+ $files = (Get-ChildItem -Recurse '$(Build.SourcesDirectory)/out/platyPS' -File).FullName
+
+ $files | ForEach-Object {
+ Write-Host "##vso[artifact.upload containerfolder=platyPS;artifactname=platyPS]$_"
+ }
+ displayName: Publish build artifact
+ timeoutInMinutes: 10
+
+ - pwsh: |
+ Register-PSRepository -Name local -SourceLocation '$(System.ArtifactsDirectory)' -Verbose -ErrorAction Ignore
+ Publish-Module -Repository local -Path '$(Build.SourcesDirectory)/out/platyPS' -Verbose
+ $nupkgFile = Get-ChildItem -Path '$(System.ArtifactsDirectory)/platyPS*.nupkg'
+
+ Write-Verbose -Verbose "Uploading: $nupkgFile"
+ Write-Host "##vso[artifact.upload containerfolder=nupkg;artifactname=nupkg]$nupkgFile"
+
+ displayName: Create module .nupkg and upload
+
+- stage: Test
+ displayName: Test Package
+ jobs:
+ - template: test.yml
+ parameters:
+ jobName: TestPkgWin
+ displayName: PowerShell Core on Windows
+ imageName: windows-2019
+
+ - template: test.yml
+ parameters:
+ jobName: TestPkgWinPS
+ displayName: Windows PowerShell on Windows
+ imageName: windows-2019
+ powershellExecutable: powershell
+
+ - template: test.yml
+ parameters:
+ jobName: TestPkgUbuntu16
+ displayName: PowerShell Core on Ubuntu 16.04
+ imageName: ubuntu-16.04
+
+ - template: test.yml
+ parameters:
+ jobName: TestPkgWinMacOS
+ displayName: PowerShell Core on macOS
+ imageName: macOS-10.14
+
+- stage: compliance
+ displayName: Compliance
+ dependsOn: Build
+ jobs:
+ - job: Compliance_Job
+ pool:
+ name: windows-latest
+ steps:
+ - checkout: self
+ - checkout: ComplianceRepo
+ - template: ci-compliance.yml@ComplianceRepo

.ci/test.yml

@@ -0,0 +1,87 @@
+parameters:
+ jobName: TestPkgWin
+ imageName: windows-latest
+ displayName: PowerShell Core on Windows
+ powershellExecutable: pwsh
+
+jobs:
+- job: ${{ parameters.jobName }}
+ pool:
+ vmImage: ${{ parameters.imageName }}
+ displayName: ${{ parameters.displayName }}
+ steps:
+ - ${{ parameters.powershellExecutable }}: |
+ Get-InstalledModule -Name pester -AllowPrerelease -MinimumVersion 5.0.0 -ErrorAction SilentlyContinue | Uninstall-Module -Force -Verbose -ErrorAction SilentlyContinue
+ displayName: Remove >= 5.0.0 Pester
+ timeoutInMinutes: 10
+
+ - ${{ parameters.powershellExecutable }}: |
+ Install-module Pester -Force -MaximumVersion 4.99
+ displayName: Install dependencies - Pester
+ timeoutInMinutes: 10
+
+ - task: DownloadBuildArtifacts@0
+ displayName: 'Download artifacts'
+ inputs:
+ buildType: current
+ downloadType: specific
+ itemPattern: '**/*.nupkg'
+ downloadPath: '$(System.ArtifactsDirectory)'
+ artifactName: 'nupkg'
+
+ - task: DotNetCoreCLI@2
+ displayName: dotnet restore
+ inputs:
+ command: restore
+ projects: '$(Build.SourcesDirectory)/**/*.csproj'
+ includeNuGetOrg: true
+
+ - ${{ parameters.powershellExecutable }}: |
+ $sourceName = 'pspackageproject-local-repo'
+ Register-PSRepository -Name $sourceName -SourceLocation '$(System.ArtifactsDirectory)/nupkg' -ErrorAction Ignore -Verbose
+ $null = New-Item -Path '$(System.ArtifactsDirectory)/saved' -ItemType Directory
+ Save-Module -Repository $sourceName -Name platyPS -Path '$(System.ArtifactsDirectory)/saved' -Verbose
+ displayName: Extract product artifact
+ timeoutInMinutes: 10
+
+ - ${{ parameters.powershellExecutable }}: |
+ $(Build.SourcesDirectory)/build.ps1 -OutputDir '$(System.ArtifactsDirectory)/saved' -Test
+
+ $pesterResult = '$(Build.SourcesDirectory)/pester.tests.xml'
+
+ if (-not (Test-Path $pesterResult))
+ {
+ throw 'Pester test results not found'
+ }
+
+ Write-Host "##vso[results.publish type=NUnit;mergeResults=true;runTitle=Pester;publishRunAttachments=true;resultFiles=$pesterResult;]"
+
+ if ($IsWindows)
+ {
+ $xunitResult = '$(Build.SourcesDirectory)/xunit.tests.xml'
+
+ if (-not (Test-Path $xunitResult))
+ {
+ throw 'xUnit test results not found'
+ }
+ }
+ displayName: Execute functional tests
+ errorActionPreference: continue
+
+ - task: PublishTestResults@2
+ inputs:
+ testResultsFormat: 'NUnit'
+ testResultsFiles: '**/pester.tests.xml'
+ testRunTitle: '${{ parameters.jobName }}-Pester'
+
+ - task: PublishTestResults@2
+ inputs:
+ testResultsFormat: 'xUnit'
+ testResultsFiles: '**/xunit.tests.xml'
+ testRunTitle: '${{ parameters.jobName }}-xUnit'
+
+ - ${{ parameters.powershellExecutable }}: |
+ Unregister-PSRepository -Name 'pspackageproject-local-repo' -ErrorAction Ignore
+ displayName: Unregister temporary PSRepository
+ condition: always()
+ timeoutInMinutes: 10

build.ps1

@@ -7,7 +7,6 @@ param(
  [ValidateSet("Debug", "Release")]
  [string] $Configuration = "Debug",
 
- [Parameter(ParameterSetName = "Build")]
  [string] $OutputDir = "$PSScriptRoot/out",
 
  [Parameter(ParameterSetName = "Test", Mandatory)]
@@ -48,8 +47,7 @@ if ($PSCmdlet.ParameterSetName -eq 'Build') {
  $expectedBuildPath = "./bin/$Configuration/net461/"
  $expectedDllPath = "$expectedBuildPath/Microsoft.PowerShell.PlatyPS.dll"
 
- if (-not (Test-Path $expectedDllPath))
- {
+ if (-not (Test-Path $expectedDllPath)) {
  throw "Build did not succeed."
  }
 
@@ -73,30 +71,27 @@ if ($PSCmdlet.ParameterSetName -eq 'Build') {
 elseif ($PSCmdlet.ParameterSetName -eq 'Test') {
  Import-Module -Name "$OutputDir/platyPS" -Force
 
- $xunitTestRoot = "$PSScriptRoot/test/Microsoft.PowerShell.PlatyPS.Tests"
- Write-Verbose "Executing XUnit tests under $xunitTestRoot" -Verbose
-
- $xunitTestFailed = $true
-
- try {
- Push-Location $xunitTestRoot
- dotnet test --test-adapter-path:. "--logger:xunit;LogFilePath=$XUnitLogPath"
-
- if ($LASTEXITCODE -eq 0) {
- $xunitTestFailed = $false
+ if ($IsWindows) {
+ try {
+ $xunitTestRoot = "$PSScriptRoot/test/Microsoft.PowerShell.PlatyPS.Tests"
+ Write-Verbose "Executing XUnit tests under $xunitTestRoot" -Verbose
+ Push-Location $xunitTestRoot
+ dotnet test --test-adapter-path:. "--logger:xunit;LogFilePath=$XUnitLogPath"
+ if ($LASTEXITCODE -ne 0) {
+ throw "XUnit test failed"
+ }
+ }
+ finally {
+ Pop-Location
  }
- }
- finally {
- Pop-Location
  }
 
  $pesterTestRoot = "$PSScriptRoot/test/Pester"
- Write-Verbose "Executing Pester tests under $pesterTestRoot"
+ Write-Verbose "Executing Pester tests under $pesterTestRoot" -Verbose
 
  $results = Invoke-Pester -Script $pesterTestRoot -PassThru -Outputformat nunitxml -outputfile $PesterLogPath
 
- if ($results.FailedCount -ne 0 -or $xunitTestFailed)
- {
- throw "Tests failed."
+ if ($results.FailedCount -ne 0) {
+ throw "Pester Tests failed."
  }
 }

src/MarkdownWriter/ModulePageWriter.cs

@@ -47,7 +47,7 @@ internal FileInfo Write(Collection<CommandHelp> helpItems)
 
  if (!string.Equals(modulePage.Extension, ".md", StringComparison.OrdinalIgnoreCase))
  {
- _modulePagePath = $"{_modulePagePath}\\{moduleName}.md";
+ _modulePagePath = $"{_modulePagePath}{Constants.DirectorySeparator}{moduleName}.md";
  }
  else
  {

test/Microsoft.PowerShell.PlatyPS.Tests/nuget.config

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+ <packageSources>
+ <clear />
+ <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3"/>
+ </packageSources>
+ <disabledPackageSources>
+ <clear />
+ </disabledPackageSources>
+</configuration>