-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpsakefile.ps1
285 lines (260 loc) · 14.7 KB
/
psakefile.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
$script:ModuleName = 'Pipelines'; # The name of your PowerShell module
$script:ProjectName = "Pipelines"; # The name of your C# Project
$script:DotnetVersion = "net7.0"; # The version of .Net the project is targeted to
$script:GithubOrg = 'mod-posh' # This could be your github username if you're not working in a Github Org
$script:Repository = "https://github.com/$($script:GithubOrg)"; # This is the Github Repo
$script:DeployBranch = 'main'; # The branch that we deploy from, typically master or main
$script:Root = $PSScriptRoot; # This will be the root of your Module Project, not the Repository Root
$script:Source = Join-Path $PSScriptRoot $script:ModuleName; # This will be the root of your Module Project, not the Repository Root
$script:Output = Join-Path $PSScriptRoot 'output'; # The module will be output into this folder
$script:Docs = Join-Path $PSScriptRoot 'docs'; # The root folder for the PowerShell Module
$script:Destination = Join-Path $Output $script:ModuleName; # The PowerShell module folder that contains the manifest and other files
$script:ModulePath = "$Destination\$script:ModuleName.dll"; # The main PowerShell Module file
$script:ManifestPath = "$Destination\$script:ModuleName.psd1"; # The main PowerShell Module Manifest
$script:TestFile = ("TestResults_$(Get-Date -Format s).xml").Replace(':', '-'); # The Pester Test output file
$script:DiscordChannel = "https://discord.com/channels/1044305359021555793/1044305781627035811" # Discord Channel
$script:PoshGallery = "https://www.powershellgallery.com/packages/$($script:ModuleName)" # The PowerShell Gallery URL
$script:Fwlink = "https://raw.githubusercontent.com/$($script:GithubOrg)/$($script:ModuleName)/main/cabs/"
$BuildHelpers = Get-Module -ListAvailable | Where-Object -Property Name -eq BuildHelpers;
if ($BuildHelpers)
{
Write-Host -ForegroundColor Blue "Info: BuildHelpers Version $($BuildHelpers.Version) Found";
Write-Host -ForegroundColor Blue "Info: This automation built with BuildHelpers Version 2.0.16";
Import-Module BuildHelpers;
}
else
{
throw "Please Install-Module -Name BuildHelpers";
}
$PowerShellForGitHub = Get-Module -ListAvailable | Where-Object -Property Name -eq PowerShellForGitHub;
if ($PowerShellForGitHub)
{
Write-Host -ForegroundColor Blue "Info: PowerShellForGitHub Version $($PowerShellForGitHub.Version) Found";
Write-Host -ForegroundColor Blue "Info: This automation built with PowerShellForGitHub Version 0.16.1";
Import-Module PowerShellForGitHub;
}
else
{
throw "Please Install-Module -Name PowerShellForGitHub";
}
$PlatyPS = Get-Module -ListAvailable | Where-Object -Property Name -eq PlatyPS;
if ($PlatyPS)
{
Write-Host -ForegroundColor Blue "Info: PowerShellForGitHub Version $($PlatyPS.Version) Found";
Write-Host -ForegroundColor Blue "Info: This automation built with PowerShellForGitHub Version 0.14.2";
Import-Module PlatyPS;
}
else
{
throw "Please Install-Module -Name PlatyPS";
}
$Pester = Get-Module -ListAvailable | Where-Object -Property Name -eq Pester;
if ($Pester)
{
Write-Host -ForegroundColor Blue "Info: PowerShellForGitHub Version $($Pester.Version) Found";
Write-Host -ForegroundColor Blue "Info: This automation built with PowerShellForGitHub Version 3.4.0";
Import-Module Pester;
}
else
{
throw "Please Install-Module -Name Pester";
}
Write-Host -ForegroundColor Green "ModuleName : $($script:ModuleName)";
Write-Host -ForegroundColor Green "ProjectName : $($script:ProjectName)";
Write-Host -ForegroundColor Green "DotnetVersion : $($script:DotnetVersion)";
Write-Host -ForegroundColor Green "GithubOrg : $($script:GithubOrg)";
Write-Host -ForegroundColor Green "Root : $($script:Root)";
Write-Host -ForegroundColor Green "Source : $($script:Source)";
Write-Host -ForegroundColor Green "Output : $($script:Output)";
Write-Host -ForegroundColor Green "Docs : $($script:Docs)";
Write-Host -ForegroundColor Green "Destination : $($script:Destination)";
Write-Host -ForegroundColor Green "ModulePath : $($script:ModulePath)";
Write-Host -ForegroundColor Green "ManifestPath : $($script:ManifestPath)";
Write-Host -ForegroundColor Green "TestFile : $($script:TestFile)";
Write-Host -ForegroundColor Green "Repository : $($script:Repository)";
Write-Host -ForegroundColor Green "DiscordChannel : $($script:DiscordChannel)";
Write-Host -ForegroundColor Green "PoshGallery : $($script:PoshGallery)";
Write-Host -ForegroundColor Green "DeployBranch : $($script:DeployBranch)";
Write-Host -ForegroundColor Green "FwLink : $($script:Fwlink)";
Task default -depends LocalUse
Task LocalUse -Description "Setup for local use and testing" -depends Clean, BuildProject, CopyModuleFiles
Task Build -depends LocalUse
Task Package -depends CreateExternalHelp, CreateCabFile, UpdateReadme
Task Deploy -depends PesterTest, CheckBranch, ReleaseNotes, PublishModule, NewTaggedRelease, Post2Discord, Post2Bluesky
Task Clean -depends CleanProject {
$null = Remove-Item $Output -Recurse -ErrorAction Ignore
$null = New-Item -Type Directory -Path $Destination -ErrorAction Ignore
$null = Remove-Item "$($script:Root)\TestResults*.xml"
}
Task UpdateReadme -Description "Update the README file" -Action {
$readMe = Get-Item .\README.md
$TableHeaders = "| Latest Version | PowerShell Gallery | Issues | License | Discord |"
$Columns = "|-----------------|----------------|----------------|----------------|----------------|"
$VersionBadge = "[/$($script:ModuleName))]($($script:Repository)/$($script:ModuleName)/tags)"
$GalleryBadge = "[)](https://www.powershellgallery.com/packages/$($script:ModuleName))"
$IssueBadge = "[/$($script:ModuleName))]($($script:Repository)/$($script:ModuleName)/issues)"
$LicenseBadge = "[/$($script:ModuleName))]($($script:Repository)/$($script:ModuleName)/blob/master/LICENSE)"
$DiscordBadge = "[]($($script:DiscordChannel))"
if (!(Get-Module -Name $script:ModuleName )) { Import-Module -Name $script:Destination }
Write-Output $TableHeaders | Out-File $readMe.FullName -Force
Write-Output $Columns | Out-File $readMe.FullName -Append
Write-Output "| $($VersionBadge) | $($GalleryBadge) | $($IssueBadge) | $($LicenseBadge) | $($DiscordBadge) |" | Out-File $readMe.FullName -Append
Get-Content "$($script:Docs)\$($script:ModuleName).md" | Select-Object -Skip 8 | ForEach-Object { $_.Replace('(', '(docs/') } | Out-File $readMe.FullName -Append
Write-Output "" | Out-File $readMe.FullName -Append
}
Task NewTaggedRelease -Description "Create a tagged release" -Action {
$Github = (Get-Content -Path "$($PSScriptRoot)\github.json") | ConvertFrom-Json
$Credential = New-Credential -Username ignoreme -Password $Github.Token
Set-GitHubAuthentication -Credential $Credential
if (!(Get-Module -Name $script:ModuleName )) { Import-Module -Name "$($script:Output)\$($script:ModuleName)" }
$Version = (Get-Module -Name $script:ModuleName | Select-Object -Property Version).Version.ToString()
git add .
git commit . -m "Updated ExternalHelp for $($Version) Release"
git push
git tag -a v$version -m "$($script:ModuleName) Version $($Version)"
git push origin v$version
New-GitHubRelease -OwnerName $script:GithubOrg -RepositoryName $script:ModuleName -Tag "v$($Version)" -Name "v$($Version)"
}
Task Post2Discord -Description "Post a message to discord" -Action {
$version = (Get-Module -Name $($script:ModuleName) | Select-Object -Property Version).Version.ToString()
$Discord = Get-Content -Path "$($PSScriptRoot)\discord.json" | ConvertFrom-Json
$Discord.message.content = "Version $($version) of $($script:ModuleName) released. Please visit Github ($($script:Repository)/$($script:ModuleName)) or PowershellGallery ($($script:PoshGallery)) to download."
Invoke-RestMethod -Uri $Discord.uri -Body ($Discord.message | ConvertTo-Json -Compress) -Method Post -ContentType 'application/json; charset=UTF-8'
}
Task Post2Bluesky -Description "Post a message to bsky.app" -Action {
$Project = [xml](Get-Content -Path "$($script:Source)\$($script:ProjectName).csproj");
$Version = $Project.Project.PropertyGroup.Version.ToString();
$createdAt = Get-Date -Format "yyyy-MM-ddTHH:mm:ss.ffffffZ"
# Authenticate
$AuthBody = Get-Content -Path "$($PSScriptRoot)\bluesky.json"
$Handle = $AuthBody | ConvertFrom-Json | Select-Object -ExpandProperty Identifier
$Headers = @{}
$Headers.Add('Content-Type', 'application/json')
$Response = Invoke-RestMethod -Uri "https://bsky.social/xrpc/com.atproto.server.createSession" -Method Post -Body $AuthBody -Headers $Headers
# Create post
$Headers.Add('Authorization', "Bearer $($Response.accessJwt)")
$Record = New-Object -TypeName psobject -Property @{
'$type' = "app.bsky.feed.post"
'text' = "Version $($version) of $($script:ModuleName) released. Please visit Github ($($script:Repository)/$($script:ModuleName)) or PowershellGallery ($($script:PoshGallery)) to download."
"createdAt" = $createdAt
}
$embeds += New-Object -TypeName psobject -Property @{
'$type'='app.bsky.embed.link'
'url'="$($script:Repository)/$($script:ModuleName)"
'title'="Github.com $($script:ModuleName)"
'description'=$project.Project.PropertyGroup.Description
}
$embeds += New-Object -TypeName psobject -Property @{
'$type'='app.bsky.embed.link'
'url'="$($script:PoshGallery)"
'title'="PowershellGallery.com $($script:ModuleName)"
'description'=$project.Project.PropertyGroup.Description
}
$Post = New-Object -TypeName psobject -Property @{
'repo' = $Handle
'collection' = 'app.bsky.feed.post'
record = $Record
embeds = $embeds
}
Invoke-RestMethod -Uri "https://bsky.social/xrpc/com.atproto.repo.createRecord" -Method Post -Body ($Post | ConvertTo-Json -Compress) -Headers $Headers
}
Task CleanProject -Description "Clean the project before building" -Action {
dotnet clean "$($PSScriptRoot)\$($script:ProjectName)\$($script:ProjectName).csproj"
}
Task BuildProject -Description "Build the project" -Action {
dotnet build "$($PSScriptRoot)\$($script:ProjectName)\$($script:ProjectName).csproj" -c Release
}
Task CopyModuleFiles -Description "Copy files for the module" -Action {
Copy-Item "$($PSScriptRoot)\$($script:ProjectName)\bin\Release\$($script:DotnetVersion)\*.dll" $script:Destination -Force
Copy-Item "$($PSScriptRoot)\$($script:ModuleName).psd1" $script:Destination -Force
}
Task CreateHelp -Description "Create the help documentation" -depends Build -Action {
Import-Module -Name $script:Destination -Force -Scope Global
$Version = (Get-Module -Name $script:ModuleName | Select-Object -Property Version).Version.ToString()
New-MarkdownHelp -Module $script:ModuleName -AlphabeticParamsOrder -OutputFolder $script:Docs -UseFullTypeName -WithModulePage -HelpVersion $Version -FwLink $script:Fwlink -Force
}
Task CreateExternalHelp -Description "Create external help file" -Action {
New-ExternalHelp -Path $script:Docs -OutputPath $script:Destination -Force
}
Task CreateCabFile -Description "Create cab file for download" -Action {
New-ExternalHelpCab -CabFilesFolder $script:Destination -LandingPagePath "$($script:Docs)\$($script:ModuleName).md" -OutputFolder "$($PSScriptRoot)\cabs\"
}
Task PesterTest -description "Test module" -action {
if (!(Get-Module -Name $script:ModuleName )) { Import-Module -Name $script:Destination }
$pesterConfig = New-PesterConfiguration @{
Run = @{
Path = "$($script:Source)\Tests\CmdletTests"
}
Output = @{
Verbosity = 'Detailed'
}
TestResult = @{
Enabled = $true
OutputPath = "$($PSScriptRoot)\$($script:TestFile)"
TestResultFormat = 'NUnitXml'
}
}
$TestResults = Invoke-Pester -Configuration $pesterConfig
if ($TestResults.FailedCount -gt 0)
{
Write-Error "Failed [$($TestResults.FailedCount)] Pester tests"
}
}
Task CheckBranch -Description "A test that should fail if we deploy while not on master" -Action {
$branch = git branch --show-current
if ($branch -ne $script:DeployBranch)
{
[System.Net.WebSockets.WebSocketException]$Exception = "You are not on the deployment branch: $($script:DeployBranch)"
[string]$ErrorId = "Git.WrongBranch"
[System.Management.Automation.ErrorCategory]$Category = [System.Management.Automation.ErrorCategory]::InvalidOperation
$PSCmdlet.ThrowTerminatingError(
[System.Management.Automation.ErrorRecord]::new(
$Exception,
$ErrorId,
$Category,
$null
)
)
}
}
Task ReleaseNotes -Description "Create release notes file for module manifest" -Action {
$Github = (Get-Content -Path "$($PSScriptRoot)\github.json") | ConvertFrom-Json
$Credential = New-Credential -Username ignoreme -Password $Github.Token
Set-GitHubAuthentication -Credential $Credential
$Milestone = (Get-GitHubMilestone -OwnerName 'mod-posh' -RepositoryName 'Pipelines' -State Closed | Sort-Object -Descending -Property Number)[0]
if ($Milestone)
{
[System.Text.StringBuilder]$stringbuilder = [System.Text.StringBuilder]::new()
[void]$stringbuilder.AppendLine( "# $($Milestone.title)" )
if ($Milestone.description)
{
[void]$stringbuilder.AppendLine( "$($Milestone.description)" )
}
$i = Get-GitHubIssue -OwnerName $script:GithubOrg -RepositoryName $script:ModuleName -RepositoryType All -Filter All -State Closed -MilestoneNumber $Milestone.Number;
$headings = $i | ForEach-Object { $_.Labels.Name } | Sort-Object -Unique;
foreach ($heading in $headings)
{
[void]$stringbuilder.AppendLine( "" )
[void]$stringbuilder.AppendLine( "## $($heading.ToUpper())" )
[void]$stringbuilder.AppendLine( "" )
$issues = $i | ForEach-Object { if ($_.Labels.Name -eq $Heading) { $_ } }
foreach ($issue in $issues)
{
[void]$stringbuilder.AppendLine( "* $($issue.title) #$($issue.issuenumber)" )
}
}
Out-File -FilePath "$($PSScriptRoot)\RELEASE.md" -InputObject $stringbuilder.ToString() -Encoding ascii -Force
$ReleaseNotes = (Get-Content -Path "$($PSScriptRoot)\RELEASE.md").Replace('## ', '-').Replace('# ', '').Replace('*', '-')
Update-Metadata -Path "$($script:Root)\$($script:ModuleName).psd1" -PropertyName ReleaseNotes -Value @($ReleaseNotes)
Copy-Item "$($PSScriptRoot)\$($script:ModuleName).psd1" $script:Destination -Force
}
}
Task PublishModule -Description "Publish module to PowerShell Gallery" -Action {
$config = [xml](Get-Content "$($PSScriptRoot)\nuget.config");
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
$Parameters = @{
Path = $script:Destination
NuGetApiKey = "$($config.configuration.apikeys.add.value)"
}
Publish-Module @Parameters;
}