forked from AtlassianPS/JiraPS
-
Notifications
You must be signed in to change notification settings - Fork 0
/
JiraPS.build.ps1
318 lines (268 loc) · 12.1 KB
/
JiraPS.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
[CmdletBinding()]
[System.Diagnostics.CodeAnalysis.SuppressMessage('PSAvoidUsingWriteHost', '')]
[System.Diagnostics.CodeAnalysis.SuppressMessage('PSAvoidUsingEmptyCatchBlock', '')]
param(
[String[]]$Tag,
[String[]]$ExcludeTag
)
$WarningPreference = "Continue"
if ($PSBoundParameters.ContainsKey('Verbose')) {
$VerbosePreference = "Continue"
}
if ($PSBoundParameters.ContainsKey('Debug')) {
$DebugPreference = "Continue"
}
try {
$script:IsWindows = (-not (Get-Variable -Name IsWindows -ErrorAction Ignore)) -or $IsWindows
$script:IsLinux = (Get-Variable -Name IsLinux -ErrorAction Ignore) -and $IsLinux
$script:IsMacOS = (Get-Variable -Name IsMacOS -ErrorAction Ignore) -and $IsMacOS
$script:IsCoreCLR = $PSVersionTable.ContainsKey('PSEdition') -and $PSVersionTable.PSEdition -eq 'Core'
}
catch { }
Set-StrictMode -Version Latest
Import-Module "$PSScriptRoot/Tools/build.psm1" -Force -ErrorAction Stop
if ($BuildTask -notin @("SetUp", "InstallDependencies")) {
Import-Module BuildHelpers -Force -ErrorAction Stop
}
#region SetUp
# Synopsis: Create an initial environment for developing on the module
task SetUp InstallDependencies, Build
# Synopsis: Install all module used for the development of this module
task InstallDependencies {
Install-PSDepend
Import-Module PSDepend -Force
$parameterPSDepend = @{
Path = "$PSScriptRoot/Tools/build.requirements.psd1"
Install = $true
Import = $true
Force = $true
ErrorAction = "Stop"
}
$null = Invoke-PSDepend @parameterPSDepend
Import-Module BuildHelpers -Force
}
# Synopsis: Ensure the build environment is all ready to go
task Init {
Set-BuildEnvironment -BuildOutput '$ProjectPath/Release' -ErrorAction SilentlyContinue
# BuildHelpers does not write the project name in the correct caps
if ($env:APPVEYOR_PROJECT_NAME) {
$env:BHProjectName = $env:APPVEYOR_PROJECT_NAME
}
Add-ToModulePath -Path $env:BHBuildOutput
}, GetNextVersion
# Synopsis: Get the next version for the build
task GetNextVersion {
$currentVersion = [Version](Get-Metadata -Path $env:BHPSModuleManifest)
if ($env:BHBuildNumber) {
$newRevision = $env:BHBuildNumber
}
else {
$newRevision = 0
}
$env:NextBuildVersion = [Version]::New($currentVersion.Major, $currentVersion.Minor, $newRevision)
$env:CurrentBuildVersion = $currentVersion
}
#endregion Setup
#region HarmonizeVariables
switch ($true) {
{$IsWindows} {
$OS = "Windows"
if (-not ($IsCoreCLR)) {
$OSVersion = $PSVersionTable.BuildVersion.ToString()
}
}
{$IsLinux} {
$OS = "Linux"
}
{$IsMacOs} {
$OS = "OSX"
}
{$IsCoreCLR} {
$OSVersion = $PSVersionTable.OS
}
}
#endregion HarmonizeVariables
#region DebugInformation
task ShowInfo Init, {
Write-Build Gray
Write-Build Gray ('Running in: {0}' -f $env:BHBuildSystem)
Write-Build Gray '-------------------------------------------------------'
Write-Build Gray
Write-Build Gray ('Project name: {0}' -f $env:BHProjectName)
Write-Build Gray ('Project root: {0}' -f $env:BHProjectPath)
Write-Build Gray ('Build Path: {0}' -f $env:BHBuildOutput)
Write-Build Gray ('Current Version: {0}' -f $env:CurrentBuildVersion)
Write-Build Gray '-------------------------------------------------------'
Write-Build Gray
Write-Build Gray ('Branch: {0}' -f $env:BHBranchName)
Write-Build Gray ('Commit: {0}' -f $env:BHCommitMessage)
Write-Build Gray ('Build #: {0}' -f $env:BHBuildNumber)
Write-Build Gray ('Next Version: {0}' -f $env:NextBuildVersion)
Write-Build Gray ('Will deploy new version? {0}' -f (Test-ShouldDeploy))
Write-Build Gray '-------------------------------------------------------'
Write-Build Gray
Write-Build Gray ('PowerShell version: {0}' -f $PSVersionTable.PSVersion.ToString())
Write-Build Gray ('OS: {0}' -f $OS)
Write-Build Gray ('OS Version: {0}' -f $OSVersion)
Write-Build Gray
}
#endregion DebugInformation
#region BuildRelease
# Synopsis: Build a shippable release
task Build GenerateRelease, UpdateManifest, Package
# Synopsis: Generate ./Release structure
task GenerateRelease Init, GenerateExternalHelp, {
# Setup
if (-not (Test-Path "$env:BHBuildOutput/$env:BHProjectName")) {
$null = New-Item -Path "$env:BHBuildOutput/$env:BHProjectName" -ItemType Directory
}
# Copy module
Copy-Item -Path "$env:BHModulePath/*" -Destination "$env:BHBuildOutput/$env:BHProjectName" -Recurse -Force
# Copy additional files
Copy-Item -Path @(
"$BuildRoot/CHANGELOG.md"
"$BuildRoot/LICENSE"
"$BuildRoot/README.md"
) -Destination "$env:BHBuildOutput/$env:BHProjectName" -Force
# Copy Tests
$null = New-Item -Path "$env:BHBuildOutput/Tests" -ItemType Directory -ErrorAction SilentlyContinue
Copy-Item -Path "$BuildRoot/Tests/*.ps1" -Destination "$env:BHBuildOutput/Tests" -Recurse -Force
# Include Analyzer Settings
Copy-Item -Path "$BuildRoot/PSScriptAnalyzerSettings.psd1" -Destination "$env:BHBuildOutput/PSScriptAnalyzerSettings.psd1" -Force
# Remove all execptions from PSScriptAnalyzer
BuildHelpers\Update-Metadata -Path "$env:BHBuildOutput/PSScriptAnalyzerSettings.psd1" -PropertyName ExcludeRules -Value ''
}
# Synopsis: Use PlatyPS to generate External-Help
task GenerateExternalHelp -If (Get-ChildItem "$BuildRoot/docs/en-US/commands" -ErrorAction SilentlyContinue) Init, {
Import-Module platyPS -Force
foreach ($locale in (Get-ChildItem "$BuildRoot/docs" -Attribute Directory)) {
New-ExternalHelp -Path "$($locale.FullName)" -OutputPath "$env:BHModulePath/$($locale.Basename)" -Force
New-ExternalHelp -Path "$($locale.FullName)/commands" -OutputPath "$env:BHModulePath/$($locale.Basename)" -Force
}
Remove-Module platyPS
}
# Synopsis: Update the manifest of the module
task UpdateManifest GetNextVersion, {
Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
Import-Module $env:BHPSModuleManifest -Force
$ModuleAlias = @(Get-Alias | Where-Object {$_.ModuleName -eq "$env:BHProjectName"})
Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
Import-Module $env:BHProjectName -Force
BuildHelpers\Update-Metadata -Path "$env:BHBuildOutput/$env:BHProjectName/$env:BHProjectName.psd1" -PropertyName ModuleVersion -Value $env:NextBuildVersion
# BuildHelpers\Update-Metadata -Path "$env:BHBuildOutput/$env:BHProjectName/$env:BHProjectName.psd1" -PropertyName FileList -Value (Get-ChildItem "$env:BHBuildOutput/$env:BHProjectName" -Recurse).Name
BuildHelpers\Set-ModuleFunctions -Name "$env:BHBuildOutput/$env:BHProjectName/$env:BHProjectName.psd1" -FunctionsToExport ([string[]](Get-ChildItem "$env:BHBuildOutput/$env:BHProjectName/Public/*.ps1").BaseName)
BuildHelpers\Update-Metadata -Path "$env:BHBuildOutput/$env:BHProjectName/$env:BHProjectName.psd1" -PropertyName AliasesToExport -Value ''
if ($ModuleAlias) {
BuildHelpers\Update-Metadata -Path "$env:BHBuildOutput/$env:BHProjectName/$env:BHProjectName.psd1" -PropertyName AliasesToExport -Value @($ModuleAlias.Name)
}
}
# Synopsis: Create a ZIP file with this build
task Package GenerateRelease, {
Remove-Item "$env:BHBuildOutput\$env:BHProjectName.zip" -ErrorAction SilentlyContinue
$null = Compress-Archive -Path "$env:BHBuildOutput\$env:BHProjectName" -DestinationPath "$env:BHBuildOutput\$env:BHProjectName.zip"
}
#endregion BuildRelease
#region Test
task Test Init, {
assert { Test-Path $env:BHBuildOutput -PathType Container }
Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
$params = @{
Path = "$env:BHBuildOutput/$env:BHProjectName"
Include = '*.ps1', '*.psm1'
Recurse = $True
# Exclude = $CodeCoverageExclude
}
$codeCoverageFiles = Get-ChildItem @params
try {
$parameter = @{
Script = "$env:BHBuildOutput/Tests/*"
Tag = $Tag
ExcludeTag = $ExcludeTag
PassThru = $true
OutputFile = "$BuildRoot/TestResult.xml"
OutputFormat = "NUnitXml"
CodeCoverage = $codeCoverageFiles
}
$parameter["Show"] = "Fails"
$testResults = Invoke-Pester @parameter
If ('AppVeyor' -eq $env:BHBuildSystem) {
BuildHelpers\Add-TestResultToAppveyor -TestFile $parameter["OutputFile"]
}
assert ($testResults.FailedCount -eq 0) "$($testResults.FailedCount) Pester test(s) failed."
}
catch {
throw $_
}
Set-BuildEnvironment -BuildOutput '$ProjectPath/Release' -ErrorAction SilentlyContinue
# BuildHelpers does not write the project name in the correct caps
if ($env:APPVEYOR_PROJECT_NAME) {
$env:BHProjectName = $env:APPVEYOR_PROJECT_NAME
}
}, RemoveTestResults, RemoveConfig
#endregion
#region Publish
# Synopsis: Publish a new release on github and the PSGallery
task Deploy -If { Test-ShouldDeploy } Init, PublishToGallery, TagReplository, UpdateHomepage
# Synipsis: Publish the $release to the PSGallery
task PublishToGallery {
assert ($env:PSGalleryAPIKey) "No key for the PSGallery"
Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
Publish-Module -Name $env:BHProjectName -NuGetApiKey $env:PSGalleryAPIKey
}
task TagReplository GetNextVersion, {
$releaseText = "Release version $env:NextBuildVersion"
# Push a tag to the repository
Write-Build Gray "git checkout $ENV:BHBranchName"
cmd /c "git checkout $ENV:BHBranchName 2>&1"
Write-Build Gray "git tag -a v$env:NextBuildVersion"
cmd /c "git tag -a v$env:NextBuildVersion 2>&1 -m `"$releaseText`""
Write-Build Gray "git push origin v$env:NextBuildVersion"
cmd /c "git push origin v$env:NextBuildVersion 2>&1"
# Publish a release on github for the tag above
$releaseResponse = Publish-GithubRelease -ReleaseText $releaseText -NextBuildVersion $env:NextBuildVersion
# Upload the package of the version to the release
$packageFile = Get-Item "$env:BHBuildOutput\$env:BHProjectName.zip" -ErrorAction Stop
$uploadURI = $releaseResponse.upload_url -replace "\{\?name,label\}", "?name=$($packageFile.Name)"
$null = Publish-GithubReleaseArtifact -Uri $uploadURI -Path $packageFile
}
# Synopsis: Update the version of this module that the homepage uses
task UpdateHomepage {
try {
Write-Build Gray "git close .../AtlassianPS.github.io --recursive"
$null = cmd /c "git clone https://github.com/AtlassianPS/AtlassianPS.github.io --recursive 2>&1"
Push-Location "AtlassianPS.github.io/"
Write-Build Gray "git submodule foreach git pull origin master"
$null = cmd /c "git submodule foreach git pull origin master 2>&1"
Write-Build Gray "git status -s"
$status = cmd /c "git status -s 2>&1"
if ($status -contains " M modules/$env:BHProjectName") {
Write-Build Gray "git add modules/$env:BHProjectName"
$null = cmd /c "git add modules/$env:BHProjectName 2>&1"
Write-Build Gray "git commit -m `"Update module $env:BHProjectName`""
cmd /c "git commit -m `"Update module $env:BHProjectName`" 2>&1"
Write-Build Gray "git push"
cmd /c "git push 2>&1"
}
Pop-Location
}
catch { Write-Warning "Failed to deploy to homepage"}
}
#endregion Publish
#region Cleaning tasks
# Synopsis: Clean the working dir
task Clean Init, RemoveGeneratedFiles, RemoveTestResults, RemoveConfig
# Synopsis: Remove generated and temp files.
task RemoveGeneratedFiles {
Remove-Item $env:BHBuildOutput -Force -Recurse -ErrorAction SilentlyContinue
}
# Synopsis: Remove Pester results
task RemoveTestResults {
Remove-Item "TestResult.xml" -Force -ErrorAction SilentlyContinue
}
# Synopsis: Remove Jira config file
task RemoveConfig {
Remove-Item "$env:BHBuildOutput\config.xml" -Force -ErrorAction SilentlyContinue
}
#endregion
task . ShowInfo, Clean, Build, Test, Deploy
Remove-Item -Path Env:\BH*