forked from psake/PowerShellBuild
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathIB.tasks.ps1
More file actions
173 lines (150 loc) · 5.97 KB
/
Copy pathIB.tasks.ps1
File metadata and controls
173 lines (150 loc) · 5.97 KB
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
Remove-Variable -Name PSBPreference -Scope Script -Force -ErrorAction Ignore
Set-Variable -Name PSBPreference -Option ReadOnly -Scope Script -Value (. (Join-Path -Path $PSScriptRoot -ChildPath build.properties.ps1))
# Synopsis: Initialize build environment variables
task Init {
Initialize-PSBuild -UseBuildHelpers -BuildEnvironment $PSBPreference
}
# Synopsis: Clears module output directory
task Clean Init, {
Clear-PSBuildOutputFolder -Path $PSBPreference.Build.ModuleOutDir
}
# Synopsis: Builds module based on source directory
task StageFiles Clean, {
$buildParams = @{
Path = $PSBPreference.General.SrcRootDir
ModuleName = $PSBPreference.General.ModuleName
DestinationPath = $PSBPreference.Build.ModuleOutDir
Exclude = $PSBPreference.Build.Exclude
Compile = $PSBPreference.Build.CompileModule
Culture = $PSBPreference.Help.DefaultLocale
}
if ($PSBPreference.Help.ConvertReadMeToAboutHelp) {
$readMePath = Get-ChildItem -Path $PSBPreference.General.ProjectRoot -Include 'readme.md', 'readme.markdown', 'readme.txt' -Depth 1 |
Select-Object -First 1
if ($readMePath) {
$buildParams.ReadMePath = $readMePath
}
}
'CompileHeader', 'CompileFooter', 'CompileScriptHeader', 'CompileScriptFooter' | ForEach-Object {
if ($PSBPreference.Build.Keys -contains $_) {
$buildParams.$_ = $PSBPreference.Build.$_
}
}
Build-PSBuildModule @buildParams
}
# Synopsis: Builds module and generate help documentation
Task Build $($PSBPreference.Build.Dependencies -join ", ")
$analyzePreReqs = {
$result = $true
if (-not $PSBPreference.Test.ScriptAnalysis.Enabled) {
Write-Warning 'Script analysis is not enabled.'
$result = $false
}
if (-not (Get-Module -Name PSScriptAnalyzer -ListAvailable)) {
Write-Warning 'PSScriptAnalyzer module is not installed'
$result = $false
}
$result
}
# Synopsis: Execute PSScriptAnalyzer tests
task Analyze Build, {
$analyzeParams = @{
Path = $PSBPreference.Build.ModuleOutDir
SeverityThreshold = $PSBPreference.Test.ScriptAnalysis.FailBuildOnSeverityLevel
SettingsPath = $PSBPreference.Test.ScriptAnalysis.SettingsPath
}
Test-PSBuildScriptAnalysis @analyzeParams
}
$pesterPreReqs = {
$result = $true
if (-not $PSBPreference.Test.Enabled) {
Write-Warning 'Pester testing is not enabled.'
$result = $false
}
if (-not (Get-Module -Name Pester -ListAvailable)) {
Write-Warning 'Pester module is not installed'
$result = $false
}
if (-not (Test-Path -Path $PSBPreference.Test.RootDir)) {
Write-Warning "Test directory [$($PSBPreference.Test.RootDir)] not found"
$result = $false
}
return $result
}
# Synopsis: Execute Pester tests
task Pester Build -If $pesterPreReqs, {
$pesterParams = @{
Path = $PSBPreference.Test.RootDir
ModuleName = $PSBPreference.General.ModuleName
OutputPath = $PSBPreference.Test.OutputFile
OutputFormat = $PSBPreference.Test.OutputFormat
CodeCoverage = $PSBPreference.Test.CodeCoverage.Enabled
CodeCoverageThreshold = $PSBPreference.Test.CodeCoverage.Threshold
CodeCoverageFiles = $PSBPreference.Test.CodeCoverage.Files
}
Test-PSBuildPester @pesterParams
}
# Synopsis: Execute Pester and ScriptAnalyzer tests
task Test Pester, Analyze, {
}
# Synopsis: Builds help documentation
task BuildHelp GenerateMarkdown, GenerateMAML, {}
$genMarkdownPreReqs = {
$result = $true
if (-not (Get-Module platyPS -ListAvailable)) {
Write-Warning "platyPS module is not installed. Skipping [$($task.name)] task."
$result = $false
}
$result
}
# Synopsis: Generates PlatyPS markdown files from module help
task GenerateMarkdown StageFiles, {
$buildMDParams = @{
ModulePath = $PSBPreference.Build.ModuleOutDir
ModuleName = $PSBPreference.General.ModuleName
DocsPath = $PSBPreference.Docs.RootDir
Locale = $PSBPreference.Help.DefaultLocale
}
Build-PSBuildMarkdown @buildMDParams
}
$genHelpFilesPreReqs = {
$result = $true
if (-not (Get-Module platyPS -ListAvailable)) {
Write-Warning "platyPS module is not installed. Skipping [$($task.name)] task."
$result = $false
}
$result
}
# Synopsis: Generates MAML-based help from PlatyPS markdown files
task GenerateMAML GenerateMarkdown, {
Build-PSBuildMAMLHelp -Path $PSBPreference.Docs.RootDir -DestinationPath $PSBPreference.Build.ModuleOutDir
}
$genUpdatableHelpPreReqs = {
$result = $true
if (-not (Get-Module platyPS -ListAvailable)) {
Write-Warning "platyPS module is not installed. Skipping [$($task.name)] task."
$result = $false
}
$result
}
# Synopsis: Create updatable help .cab file based on PlatyPS markdown help
task GenerateUpdatableHelp BuildHelp, {
Build-PSBuildUpdatableHelp -DocsPath $PSBPreference.Docs.RootDir -OutputPath $PSBPreference.Help.UpdatableHelpOutDir
}
# Synopsis: Publish module to the defined PowerShell repository
Task Publish Test, {
Assert ($PSBPreference.Publish.PSRepositoryApiKey -or $PSBPreference.Publish.PSRepositoryCredential) "API key or credential not defined to authenticate with [$($PSBPreference.Publish.PSRepository)] with."
$publishParams = @{
Path = $PSBPreference.Build.ModuleOutDir
Version = $PSBPreference.General.ModuleVersion
Repository = $PSBPreference.Publish.PSRepository
Verbose = $true #$VerbosePreference
}
if ($PSBPreference.Publish.PSRepositoryApiKey) {
$publishParams.ApiKey = $PSBPreference.Publish.PSRepositoryApiKey
}
if ($PSBPreference.Publish.PSRepositoryCredential) {
$publishParams.Credential = $PSBPreference.Publish.PSRepositoryCredential
}
Publish-PSBuildModule @publishParams
}