-
Notifications
You must be signed in to change notification settings - Fork 9
/
PSModule.build.ps1
483 lines (422 loc) · 24.3 KB
/
PSModule.build.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
#requires -version 5
#Build Script for Powershell Modules
#Uses Invoke-Build (https://github.com/nightroman/Invoke-Build)
#Run by changing to the project root directory and run ./Invoke-Build.ps1
#Uses a master-always-deploys strategy and semantic versioning - http://nvie.com/posts/a-successful-git-branching-model/
param (
#Skip publishing to various destinations (Appveyor,Github,PowershellGallery,etc.)
[Switch]$SkipPublish,
#Force deployment step even if we are not in master. If you are following GitFlow or GitHubFlow you should never need to do this.
[Switch]$ForceDeploy,
#Show detailed environment variables
[Switch]$ShowEnvironmentVariables,
#Powershell modules required for the build process
[String[]]$BuildHelperModules = @("BuildHelpers","Pester","powershell-yaml","Microsoft.Powershell.Archive","PSScriptAnalyzer"),
#Which build files/folders should be excluded from packaging
[String[]]$BuildFilesToExclude = @("Build","BuildOutput","Tests",".git*","appveyor.yml","gitversion.yml","*.build.ps1",".vscode",".placeholder"),
#NuGet API Key for Powershell Gallery Deployment. Defaults to environment variable of the same name
[String]$NuGetAPIKey = $env:NuGetAPIKey,
#GitHub User for Github Releases. Defaults to environment variable of the same name
[String]$GitHubUserName = $env:GitHubAPIKey,
#GitHub API Key for Github Releases. Defaults to environment variable of the same name
[String]$GitHubAPIKey = $env:GitHubAPIKey
)
#Initialize Build Environment
Enter-Build {
#Initialize Script-scope variables
$ArtifactPaths = @()
$ProjectBuildVersion = $null
$ProjectBuildPath = $null
$lines = '----------------------------------------------------------------'
function Write-VerboseHeader ([String]$Message) {
#Simple function to add lines around a header
write-verbose ""
write-verbose $lines
write-verbose $Message
write-verbose $lines
}
#Detect if we are in a continuous integration environment (Appveyor, etc.) or otherwise running noninteractively
if ($ENV:CI -or ([Environment]::GetCommandLineArgs() -like '-noni*')) {
write-build Green 'Build Initialization: Detected a Noninteractive or CI environment, disabling prompt confirmations'
$SCRIPT:CI = $true
$ConfirmPreference = 'None'
$ProgressPreference = "SilentlyContinue"
}
#Fetch Build Helper Modules using Install-ModuleBootstrap script (works in PSv3/4)
#The comma in ArgumentList a weird idiosyncracy to make sure a nested array is created to ensure Argumentlist
#doesn't unwrap the buildhelpermodules as individual arguments
#We suppress verbose output for master builds (because they should have already been built once cleanly)
foreach ($BuildHelperModuleItem in $BuildHelperModules) {
if (-not (Get-module $BuildHelperModuleItem -listavailable)) {
write-verbose "Build Initialization: Installing $BuildHelperModuleItem from Powershell Gallery to your currentuser module directory"
if ($PSVersionTable.PSVersion.Major -lt 5) {
write-verboseheader "Bootstrapping Powershell Module: $BuildHelperModuleItem"
Invoke-Command -ArgumentList @(, $BuildHelperModules) -ScriptBlock ([scriptblock]::Create((new-object net.webclient).DownloadString('https://git.io/PSModBootstrap')))
} else {
$installModuleParams = @{
Scope = "CurrentUser"
Name = $BuildHelperModuleItem
ErrorAction = "Stop"
}
if ($SCRIPT:CI) {
$installModuleParams.Force = $true
}
install-module @installModuleParams
}
}
}
#Initialize helpful build environment variables
$Timestamp = Get-date -uformat "%Y%m%d-%H%M%S"
$PSVersion = $PSVersionTable.PSVersion.Major
Set-BuildEnvironment -force
$PassThruParams = @{}
#If the branch name is master-test, run the build like we are in "master"
if ($env:BHBranchName -eq 'master-test') {
write-build Magenta "Detected master-test branch, running as if we were master"
$SCRIPT:BranchName = "master"
} else {
$SCRIPT:BranchName = $env:BHBranchName
}
write-build Green "Current Branch Name: $BranchName"
if ( ($VerbosePreference -ne 'SilentlyContinue') -or ($CI -and ($BranchName -ne 'master')) ) {
write-build Green "Build Initialization: Verbose Build Logging Enabled"
$SCRIPT:VerbosePreference = "Continue"
$PassThruParams.Verbose = $true
}
write-verboseheader "Build Environment Prepared! Environment Information:"
Get-BuildEnvironment | format-list | out-string | write-verbose
if ($ShowEnvironmentVariables) {
write-verboseheader "Current Environment Variables"
get-childitem env: | out-string | write-verbose
write-verboseheader "Powershell Variables"
Get-Variable | select-object name, value, visibility | format-table -autosize | out-string | write-verbose
}
# #Register Nuget
# if (!(get-packageprovider "Nuget" -ForceBootstrap -ErrorAction silentlycontinue)) {
# write-verbose "Nuget Provider Not found. Fetching..."
# Install-PackageProvider Nuget -forcebootstrap -scope currentuser @PassThruParams | out-string | write-verbose
# write-verboseheader "Installed Nuget Provider Info"
# Get-PackageProvider Nuget @PassThruParams | format-list | out-string | write-verbose
# }
# #Fix a bug with the Appveyor 2017 image having a broken nuget (points to v3 URL but installed packagemanagement doesn't query v3 correctly)
# #Next command will add this back
# if ($ENV:APPVEYOR -and ($ENV:APPVEYOR_BUILD_WORKER_IMAGE -eq 'Visual Studio 2017')) {
# write-verbose "Detected Appveyor VS2017 Image, using v2 Nuget API"
# UnRegister-PackageSource -Name nuget.org
# }
# #Add the nuget repository so we can download things like GitVersion
# if (!(Get-PackageSource "nuget.org" -erroraction silentlycontinue)) {
# write-verbose "Registering nuget.org as package source"
# Register-PackageSource -provider NuGet -name nuget.org -location http://www.nuget.org/api/v2 -Trusted @PassThruParams | out-string | write-verbose
# }
# else {
# $nugetOrgPackageSource = Set-PackageSource -name 'nuget.org' -Trusted @PassThruParams
# if ($PassThruParams.Verbose) {
# write-verboseheader "Nuget.Org Package Source Info "
# $nugetOrgPackageSource | format-table | out-string | write-verbose
# }
# }
#Move to the Project Directory if we aren't there already
Set-Location $buildRoot
#Define the Project Build Path
$SCRIPT:ProjectBuildPath = $ENV:BHBuildOutput + "\" + $ENV:BHProjectName
Write-Build Green "Module Build Output Path: $ProjectBuildPath"
#Force TLS 1.2 for all HTTPS transactions
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
}
task Clean {
#Reset the BuildOutput Directory
if (test-path $env:BHBuildOutput) {
Write-Verbose "Removing and resetting Build Output Path: $($ENV:BHBuildOutput)"
remove-item $env:BHBuildOutput -Recurse -Force @PassThruParams
}
New-Item -ItemType Directory $ProjectBuildPath -force | ForEach-Object FullName | out-string | write-verbose
#Unmount any modules named the same as our module
}
task Version {
#This task determines what version number to assign this build
$GitVersionConfig = "$buildRoot/GitVersion.yml"
#Fetch GitVersion
#TODO: Use Nuget.exe to fetch to make this v3/v4 compatible
$GitVersionCMDPackageName = "gitversion.commandline"
$GitVersionCMDPackage = Get-Package $GitVersionCMDPackageName -erroraction SilentlyContinue
if (!($GitVersionCMDPackage)) {
write-verbose "Package $GitVersionCMDPackageName Not Found Locally, Installing..."
write-verboseheader "Nuget.Org Package Source Info for fetching GitVersion"
Get-PackageSource | Format-Table | out-string | write-verbose
#Fetch GitVersion
$GitVersionCMDPackage = Install-Package $GitVersionCMDPackageName -scope currentuser -source 'nuget.org' -force @PassThruParams
}
$GitVersionEXE = ((Get-Package $GitVersionCMDPackageName).source | split-path -Parent) + "\tools\GitVersion.exe"
#Does this project have a module manifest? Use that as the Gitversion starting point (will use this by default unless project is tagged higher)
#Uses Powershell-YAML module to read/write the GitVersion.yaml config file
if (Test-Path $env:BHPSModuleManifest) {
write-verbose "Fetching Version from Powershell Module Manifest (if present)"
$ModuleManifestVersion = [Version](Get-Metadata $env:BHPSModuleManifest)
if (Test-Path $buildRoot/GitVersion.yml) {
$GitVersionConfigYAML = [ordered]@{}
#ConvertFrom-YAML returns as individual key-value hashtables, we need to combine them into a single hashtable
(Get-Content $GitVersionConfig | ConvertFrom-Yaml) | foreach-object {$GitVersionConfigYAML += $PSItem}
$GitVersionConfigYAML.'next-version' = $ModuleManifestVersion.ToString()
$GitVersionConfigYAML | ConvertTo-Yaml | Out-File $GitVersionConfig
}
else {
@{"next-version" = $ModuleManifestVersion.toString()} | ConvertTo-Yaml | Out-File $GitVersionConfig
}
}
#Calcuate the GitVersion
write-verbose "Executing GitVersion to determine version info"
$GitVersionCommand = "$GitVersionEXE $buildRoot"
$GitVersionOutput = Invoke-BuildExec { & $GitVersionEXE $buildRoot}
#Since GitVersion doesn't return error exit codes, we look for error text in the output in the output
if ($GitVersionOutput -match '^[ERROR|INFO] \[') {throw "An error occured when running GitVersion.exe $buildRoot"}
try {
$GitVersionInfo = $GitVersionOutput | ConvertFrom-JSON -ErrorAction stop
} catch {
throw "There was an error when running GitVersion.exe $buildRoot. The output of the command (if any) follows:"
$GitVersionOutput
}
write-verboseheader "GitVersion Results"
$GitVersionInfo | format-list | out-string | write-verbose
#If we are in the develop branch, add the prerelease number as revision
#TODO: Make the develop and master regex customizable in a settings file
if ($BranchName -match '^dev(elop)?(ment)?$') {
$SCRIPT:ProjectBuildVersion = ($GitVersionInfo.MajorMinorPatch + "." + $GitVersionInfo.PreReleaseNumber)
} else {
$SCRIPT:ProjectBuildVersion = [Version] $GitVersionInfo.MajorMinorPatch
}
$SCRIPT:ProjectSemVersion = $($GitVersionInfo.fullsemver)
write-build Green "Task $($task.name)`: Using Project Version: $ProjectBuildVersion"
write-build Green "Task $($task.name)`: Using Project Version (Extended): $($GitVersionInfo.fullsemver)"
}
#Copy all powershell module "artifacts" to Build Directory
task CopyFilesToBuildDir {
#Make sure we are in the project location in case somethign changedf
Set-Location $buildRoot
#The file or file paths to copy, excluding the powershell psm1 and psd1 module and manifest files which will be autodetected
#TODO: Move this somewhere higher in the hierarchy into a settings file, or rather go the "exclude" route
$FilesToCopy = "lib","Public","Private","Types","LICENSE","README.md","$($Env:BHProjectName).psm1","$($Env:BHProjectName).psd1"
copy-item -Recurse -Path $buildRoot\* -Exclude $BuildFilesToExclude -Destination $ProjectBuildPath @PassThruParams
}
#Update the Metadata of the Module with the latest Version
task UpdateMetadata CopyFilesToBuildDir,Version,{
# Load the module, read the exported functions, update the psd1 FunctionsToExport
# Because this loads/locks assembiles and can affect cleans in the same session, copy it to a temporary location, find the changes, and apply to original module.
# TODO: Find a cleaner solution, like update Set-ModuleFunctions to use a separate runspace or include a market to know we are in ModuleFunctions so when loading the module we can copy the assemblies to temp files first
$ProjectBuildManifest = ($ProjectBuildPath + "\" + (split-path $env:BHPSModuleManifest -leaf))
$tempModuleDir = [System.IO.Path]::GetTempFileName()
Remove-Item $tempModuleDir -verbose:$false
New-Item -Type Directory $tempModuleDir | out-null
copy-item -recurse $ProjectBuildPath/* $tempModuleDir
$TempModuleManifest = ($tempModuleDir + "\" + (split-path $env:BHPSModuleManifest -leaf))
Set-ModuleFunctions $tempModuleManifest @PassThruParams
$moduleFunctionsToExport = Get-MetaData -Path $tempModuleManifest -PropertyName FunctionsToExport
Update-Metadata -Path $ProjectBuildManifest -PropertyName FunctionsToExport -Value $moduleFunctionsToExport
# Set the Module Version to the calculated Project Build version
Update-Metadata -Path $ProjectBuildManifest -PropertyName ModuleVersion -Value $ProjectBuildVersion
# Are we in the master or develop/development branch? Bump the version based on the powershell gallery if so, otherwise add a build tag
if ($BranchName -match '^(master|dev(elop)?(ment)?)$') {
write-build Green "Task $($task.name)`: In Master/Develop branch, adding Tag Version $ProjectBuildVersion to this build"
$Script:ProjectVersion = $ProjectBuildVersion
if (-not (git tag -l $ProjectBuildVersion)) {
git tag "$ProjectBuildVersion"
} else {
write-warning "Tag $ProjectBuildVersion already exists. This is normal if you are running multiple builds on the same commit, otherwise this should not happen"
}
<# TODO: Add some intelligent logic to tagging releases
if (-not $CI) {
git push origin $ProjectBuildVersion | write-verbose
}
#>
<# TODO: Add a Powershell Gallery Check on the module
if (Get-NextNugetPackageVersion -Name (Get-ProjectName) -ErrorAction SilentlyContinue) {
Update-Metadata -Path $env:BHPSModuleManifest -PropertyName ModuleVersion -Value (Get-NextNugetPackageVersion -Name (Get-ProjectName))
}
#>
} else {
write-build Green "Task $($task.name)`: Not in Master/Develop branch, marking this as a feature prelease build"
$Script:ProjectVersion = $ProjectSemVersion
#Set an email address for tag commit to work if it isn't already present
if (-not (git config user.email)) {
git config user.email "buildtag@$env:ComputerName"
$tempTagGitEmailSet = $true
}
try {
$gitVersionTag = "v$ProjectSemVersion"
if (-not (git tag -l $gitVersionTag)) {
exec { git tag "$gitVersionTag" -a -m "Automatic GitVersion Prerelease Tag Generated by Invoke-Build" }
} else {
write-warning "Tag $gitVersionTag already exists. This is normal if you are running multiple builds on the same commit, otherwise this should not happen"
}
} finally {
if ($tempTagGitEmailSet) {
git config --unset user.email
}
}
#Create an empty file in the root directory of the module for easy identification that its not a valid release.
"This is a prerelease build and not meant for deployment!" > (Join-Path $ProjectBuildPath "PRERELEASE-$ProjectSemVersion")
}
# Add Release Notes from current version
# TODO: Generate Release Notes from Github
#Update-Metadata -Path $env:BHPSModuleManifest -PropertyName ReleaseNotes -Value ("$($env:APPVEYOR_REPO_COMMIT_MESSAGE): $($env:APPVEYOR_REPO_COMMIT_MESSAGE_EXTENDED)")
}
#Pester Testing
task Pester {
$BuildOutputProject = Join-Path $env:BHBuildOutput $env:BHProjectName
$ModuleManifestPath = Join-Path $BuildOutputProject '\*.psd1'
if (-not (Test-Path $ModuleManifestPath)) {throw "Module Manifest not found at $ModuleManifestPath. Did you run 'Invoke-Build Build' first?"}
write-verboseheader "Starting Pester Tests..."
$PesterResultFile = "$($env:BHBuildOutput)\$($env:BHProjectName)-TestResults_PS$PSVersion`_$TimeStamp.xml"
$PesterParams = @{
Script = "Tests"
OutputFile = $PesterResultFile
OutputFormat = "NunitXML"
PassThru = $true
}
#If we are in vscode, add the VSCodeMarkers
if ($host.name -match 'Visual Studio Code') {
write-verbose "Detected Visual Studio Code, adding test markers"
$PesterParams.PesterOption = (new-pesteroption -IncludeVSCodeMarker)
}
Invoke-Pester @PesterParams | Out-Null
# In Appveyor? Upload our test results!
If ($ENV:APPVEYOR) {
$UploadURL = "https://ci.appveyor.com/api/testresults/nunit/$($env:APPVEYOR_JOB_ID)"
write-verbose "Detected we are running in AppVeyor"
write-verbose "Uploading Pester Results to Appveyor: $UploadURL"
(New-Object 'System.Net.WebClient').UploadFile(
"https://ci.appveyor.com/api/testresults/nunit/$($env:APPVEYOR_JOB_ID)",
$PesterResultFile )
}
# Failed tests?
# Need to error out or it will proceed to the deployment. Danger!
if ($TestResults.FailedCount -gt 0) {
Write-Error "Failed '$($TestResults.FailedCount)' tests, build failed"
}
"`n"
}
task Package Version,{
$ZipArchivePath = (join-path $env:BHBuildOutput "$env:BHProjectName-$ProjectBuildVersion.zip")
write-build green "Task $($task.name)`: Writing Finished Module to $ZipArchivePath"
#Package the Powershell Module
Compress-Archive -Path $ProjectBuildPath -DestinationPath $ZipArchivePath -Force @PassThruParams
$SCRIPT:ArtifactPaths += $ZipArchivePath
#If we are in Appveyor, push completed zip to Appveyor Artifact
if ($env:APPVEYOR) {
write-build Green "Task $($task.name)`: Detected Appveyor, pushing Powershell Module archive to Artifacts"
Push-AppveyorArtifact $ZipArchivePath
}
}
task PreDeploymentChecks {
#Do not proceed if the most recent Pester test is not passing.
$CurrentErrorActionPreference = $ErrorActionPreference
try {
$ErrorActionPreference = "Stop"
$MostRecentPesterTestResult = [xml]((Get-Content -raw (get-item "$ENV:BHBuildOutput/*-TestResults*.xml" | Sort-Object lastwritetime | Select-Object -last 1)))
$MostRecentPesterTestResult = $MostRecentPesterTestResult."test-results"
if (
$MostRecentPesterTestResult -isnot [System.XML.XMLElement] -or
$MostRecentPesterTestResult.errors -gt 0 -or
$MostRecentPesterTestResult.failures -gt 0
) {throw "Fail!"}
} catch {
throw "Unable to detect a clean passing Pester Test nunit xml file in the $env:BHBuildOutput directory. Did you run {Invoke-Build Build,Test} and ensure it passed all tests first?"
}
finally {
$ErrorActionPreference = $CurrentErrorActionPreference
}
if (($env:BHBranchName -eq 'master') -or $ForceDeploy) {
if (-not (Get-Item $ProjectBuildPath/*.psd1 -erroraction silentlycontinue)) {throw "No Powershell Module Found in $ProjectBuildPath. Skipping deployment. Did you remember to build it first with {Invoke-Build Build}?"}
} else {
write-build Magenta "Task $($task.name)`: We are not in master branch, skipping publish. If you wish to deploy anyways such as for testing, run {InvokeBuild Deploy -ForceDeploy:$true}"
$script:SkipPublish=$true
}
}
task PublishGitHubRelease -if (-not $SkipPublish) Package,{
#TODO: Add Prerelease Logic when message commit says "!prerelease" or is in a release branch
if ($AppVeyor -and -not $GitHubAPIKey) {
write-build DarkYellow "Task PublishGitHubRelease: Couldn't find GitHubAPIKey in the Appveyor secure environment variables. Did you save your Github API key as an Appveyor Secure Variable? https://docs.microsoft.com/en-us/powershell/gallery/psgallery/creating-and-publishing-an-item and https://github.com/settings/tokens"
$SkipGitHubRelease = $true
}
if (-not $GitHubAPIKey) {
#TODO: Add Windows Credential Store support and some kind of Linux secure storage or caching option
write-build DarkYellow 'Task PublishGitHubRelease: $env:GitHubAPIKey was not found as an environment variable. Please specify it or use {Invoke-Build Deploy -GitHubUser "MyGitHubUser" -GitHubAPIKey "MyAPIKeyString"}. Have you created a GitHub API key with minimum public_repo scope permissions yet? https://github.com/settings/tokens'
$SkipGitHubRelease = $true
}
if (-not $GitHubUserName) {
write-build DarkYellow 'Task PublishGitHubRelease: $env:GitHubUserName was not found as an environment variable. Please specify it or use {Invoke-Build Deploy -GitHubUser "MyGitHubUser" -GitHubAPIKey "MyAPIKeyString"}. Have you created a GitHub API key with minimum public_repo scope permissions yet? https://github.com/settings/tokens'
$SkipGitHubRelease = $true
}
if ($SkipGitHubRelease) {
write-build Magenta "Task $($task.name): Skipping Publish to GitHub Releases"
} else {
#TODO: Add Prerelease Logic when message commit says "!prerelease" or is in a release branch
#Inspiration from https://www.herebedragons.io/powershell-create-github-release-with-artifact
#Create the release
$releaseData = @{
tag_name = [string]::Format("v{0}", $ProjectBuildVersion);
target_commitish = "master";
name = [string]::Format("v{0}", $ProjectBuildVersion);
body = $env:BHCommitMessage;
draft = $true;
prerelease = $true;
}
$auth = 'Basic ' + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes($GitHubApiKey + ":x-oauth-basic"))
$releaseParams = @{
Uri = "https://api.github.com/repos/$gitHubUserName/$env:BHProjectName/releases"
Method = 'POST'
Headers = @{
Authorization = $auth
}
ContentType = 'application/json'
Body = (ConvertTo-Json $releaseData -Compress)
}
$result = Invoke-RestMethod @releaseParams -ErrorAction stop
$uploadUriBase = $result.upload_url -creplace '\{\?name,label\}' # Strip the , "?name=$artifact" part
$uploadParams = @{
Method = 'POST';
Headers = @{
Authorization = $auth;
}
ContentType = 'application/zip';
}
foreach ($artifactItem in $artifactPaths) {
$uploadparams.URI = $uploadUriBase + "?name=$(split-path $artifactItem -leaf)"
$uploadparams.Infile = $artifactItem
$result = Invoke-RestMethod @uploadParams -erroraction stop
}
}
}
#TODO: Replace SkipPublish Logic with Proper invokebuild task skipping
task PublishPSGallery -if (-not $SkipPublish) {
if ($AppVeyor -and -not $NuGetAPIKey) {
write-build DarkYellow "Couldn't find NuGetAPIKey in the Appveyor secure environment variables. Did you save your NuGet/Powershell Gallery API key as an Appveyor Secure Variable? https://docs.microsoft.com/en-us/powershell/gallery/psgallery/creating-and-publishing-an-item and https://www.appveyor.com/docs/build-configuration/"
$SkipPSGallery = $true
}
if (-not $NuGetAPIKey) {
#TODO: Add Windows Credential Store support and some kind of Linux secure storage or caching option
write-build DarkYellow '$env:NuGetAPIKey was not found as an environment variable. Please specify it or use {Invoke-Build Deploy -NuGetAPIKey "MyAPIKeyString"}. Have you registered for a Powershell Gallery API key yet? https://docs.microsoft.com/en-us/powershell/gallery/psgallery/creating-and-publishing-an-item'
$SkipPSGallery = $true
}
if ($SkipPublish) {
Write-Build Magenta "Task $($task.name)`: Skipping Powershell Gallery Publish"
} else {
$publishParams = @{
Path = $ProjectBuildPath
NuGetApiKey = $NuGetAPIKey
Repository = 'PSGallery'
Force = $true
ErrorAction = 'Stop'
Confirm = $false
}
#TODO: Add Prerelease Logic when message commit says "!prerelease"
Publish-Module @publishParams @PassThruParams
}
}
### SuperTasks
# These are the only supported items to run directly from Invoke-Build
task Deploy PreDeploymentChecks,Package,PublishGitHubRelease,PublishPSGallery
task Build Clean, CopyFilesToBuildDir
task Test Pester
#Default Task - Build, Test with Pester, Deploy
task . Clean,Build,Test,Deploy