Working with Build Options

2019-03-27 18:19:50 -04:00
parent 9ff003bbe0
commit 2eaba75318
4 changed files with 157 additions and 12 deletions
@@ -0,0 +1,73 @@
+# This file stores variables which are used by the build script
+
+# Storing all values in a single $Settings variable to make it obvious that the values are coming from this BuildSettings file when accessing them.
+$Settings = @{
+
+    BuildOutput               = "$PSScriptRoot\BuildOutput"
+    Dependency                = @('Pester', 'PsScriptAnalyzer', 'platyPS')
+    SourceFolder              = "$PSScriptRoot\ZertoApiWrapper"
+    #SourceFolder              = "$PSScriptRoot\$($env:APPVEYOR_PROJECT_NAME)"
+    #TestUploadUrl             = "https://ci.appveyor.com/api/testresults/nunit/$($env:APPVEYOR_JOB_ID)"
+    #CoverallsKey              = $env:Coveralls_Key
+    #Branch                    = $env:APPVEYOR_REPO_BRANCH
+
+    UnitTestParams            = @{
+        Script       = '.\Tests\Unit'
+        CodeCoverage = (Get-ChildItem -Path '.\PSCodeHealth\' -File -Filter "*.ps1" -Recurse).FullName | Where-Object { $_ -Match "Public|Private" }
+        OutputFile   = "$PSScriptRoot\BuildOutput\UnitTestsResult.xml"
+        PassThru     = $True
+    }
+
+    IntegrationTestParams     = @{
+        Script     = '.\Tests\Integration'
+        OutputFile = "$PSScriptRoot\BuildOutput\IntegrationTestsResult.xml"
+        PassThru   = $True
+    }
+
+    AnalyzeParams             = @{
+        Path     = "$PSScriptRoot\$($env:APPVEYOR_PROJECT_NAME)"
+        Severity = 'Error'
+        Recurse  = $True
+    }
+
+    IsPullRequest             = ($env:APPVEYOR_PULL_REQUEST_NUMBER -gt 0)
+    Version                   = $env:APPVEYOR_BUILD_VERSION
+    ManifestPath              = '{0}\{1}\{1}.psd1' -f $PSScriptRoot, $env:APPVEYOR_PROJECT_NAME
+    VersionRegex              = "ModuleVersion\s=\s'(?<ModuleVersion>\S+)'" -as [regex]
+
+    ModuleName                = $env:APPVEYOR_PROJECT_NAME
+    HeaderPath                = "$PSScriptRoot\header-mkdocs.yml"
+    MkdocsPath                = "$PSScriptRoot\mkdocs.yml"
+    PublicFunctionDocsPath    = "$PSScriptRoot\docs\PublicFunctions"
+    PlatyPSParams             = @{
+        Module       = $env:APPVEYOR_PROJECT_NAME
+        OutputFolder = "$PSScriptRoot\docs\PublicFunctions"
+        NoMetadata   = $True
+        Force        = $True
+    }
+    PrivateFunctionDocsPath   = "$PSScriptRoot\docs\InternalFunctions"
+    InternalDocsPlatyPSParams = @{
+        OutputFolder  = "$PSScriptRoot\docs\InternalFunctions"
+        WarningAction = 'SilentlyContinue'
+        NoMetadata    = $True
+        Force         = $True
+    }
+    FunctionsToExclude        = @('Write-VerboseOutput', 'Get-SwitchCombination')
+
+    GitHubKey                 = $env:GitHub_Key
+    Email                     = 'MathieuBuisson@users.noreply.github.com'
+    Name                      = 'Mathieu Buisson'
+    ScreenshotPath            = "$($env:TEMP)\*Screenshot.png"
+    PSGalleryKey              = $env:PSGallery_Key
+    OutputModulePath          = "$PSScriptRoot\BuildOutput\$($env:APPVEYOR_PROJECT_NAME)"
+}
+
+$ModuleManifestParams = @{
+    RootModule        = "ZertoApiWrapper"
+    GUID              = '4c0b9e17-141b-4dd5-8549-fb21cccaa325'
+    Author            = 'Wes Carroll'
+    CompanyName       = 'Zerto'
+    Copyright         = "(c) $(Get-Date -Format "yyyy") Wes Carroll. All rights reserved."
+    Description       = 'PowerShell Core Wrapper Module for Zerto Virtual Manager API'
+    PowerShellVersion = '6.0.0'
+}