-
Notifications
You must be signed in to change notification settings - Fork 0
/
psakefile.ps1
239 lines (214 loc) · 12.8 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
$script:ProjectName = "TerraformRegistryClient"; # 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 $script:Root $script:ProjectName; # This will be the root of your Module Project, not the Repository Root
$script:Output = Join-Path $script:Root 'output'; # The module will be output into this folder
$script:Docs = Join-Path $script:Root 'docs'; # The root folder for the PowerShell Module
$script:TestFile = ("TestResults_$(Get-Date -Format s).xml").Replace(':', '-'); # The Pester Test output file
$script:DiscordChannel = "https://discord.com/channels/" # Discord Channel
$script:NugetOrg = "https://www.nuget.org/packages" # The Nuget.org URL
$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";
}
$DotnetTools = dotnet tool list --global;
$DefaultDocumentationArray = ($DotnetTools |Select-String 'defaultdocumentation').ToString() -split '\s+';
$DefaultDocumentation = New-Object PSObject -Property @{
PackageId = $DefaultDocumentationArray[0]
Version = $DefaultDocumentationArray[1]
Commands = $DefaultDocumentationArray[2]
}
if ($DefaultDocumentation)
{
Write-Host -ForegroundColor Blue "Info: DefaultDocumentation Version $($DefaultDocumentation.Version) Found";
Write-Host -ForegroundColor Blue "Info: This automation built with PowerShellForGitHub Version 0.8.2";
}
else
{
throw "Please dotnet tool install DefaultDocumentation.Console -g";
}
$gitConfigList =(git config --list) -split '\n';
$gitConfig = @{};
foreach ($str in $gitConfigList) {
$keyValue = $str -split '='
$gitConfig[$keyValue[0]] = $keyValue[1]
}
if ($gitConfig['user.email'] -and $gitConfig['user.name'])
{
Write-Host -ForegroundColor Blue "Info: Git Config has been setup";
}
else
{
throw "please run git config user.email, git config user.name"
}
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 "TestFile : $($script:TestFile)";
Write-Host -ForegroundColor Green "Repository : $($script:Repository)";
Write-Host -ForegroundColor Green "DiscordChannel : $($script:DiscordChannel)";
Write-Host -ForegroundColor Green "NugetOrg : $($script:NugetOrg)";
Write-Host -ForegroundColor Green "DeployBranch : $($script:DeployBranch)";
Task default -depends LocalUse
Task LocalUse -Description "Setup for local use and testing" -depends Clean, BuildProject
Task Build -depends LocalUse, TestProject
Task Package -depends UpdateReadme, CreateDocumentation, PackageProject
Task Deploy -depends CheckBranch, PublishProject, NewTaggedRelease
Task Notifications -depends Post2Discord, Post2Bluesky
Task Clean -depends CleanProject {
$null = Remove-Item $script:Output -Recurse -ErrorAction Ignore
$null = New-Item -Type Directory -Path $script:Output -ErrorAction Ignore
$null = New-Item -Type Directory -Path $script:Docs -ErrorAction Ignore
$null = Remove-Item "$($script:Root)\TestResults*.xml"
}
Task UpdateReadme -Description "Update the README file" -Action {
$Project = [xml](Get-Content -Path "$($script:Source)\$($script:ProjectName).csproj");
$PackageId = $Project.Project.PropertyGroup.PackageId;
$readMe = Get-Item -Path "$($script:Root)\README.md"
$TableHeaders = "| Latest Version | Nuget.org | Issues | License | Discord |"
$Columns = "|-----------------|----------------|----------------|----------------|----------------|"
$VersionBadge = "[/$($script:ProjectName))]($($script:Repository)/$($script:ProjectName)/tags)"
$GalleryBadge = "[)]($($script:NugetOrg)/$($PackageId))"
$IssueBadge = "[/$($script:ProjectName))]($($script:Repository)/$($script:ProjectName)/issues)"
$LicenseBadge = "[/$($script:ProjectName))]($($script:Repository)/$($script:ProjectName)/blob/master/LICENSE)"
$DiscordBadge = "[]($($script:DiscordChannel))"
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 -Path "$($script:Root)\$($script:ProjectName).md" |Out-File -FilePath $readMe.FullName -Append
}
Task NewTaggedRelease -Description "Create a tagged release" -Action {
$Github = (Get-Content -Path "$($script:Root)\github.json") | ConvertFrom-Json
$Credential = New-Credential -Username ignoreme -Password $Github.Token
Set-GitHubAuthentication -Credential $Credential
$Project = [xml](Get-Content -Path "$($script:Source)\$($script:ProjectName).csproj");
$Version = $Project.Project.PropertyGroup.Version.ToString();
git add .
git commit . -m "$($script:ProjectName) $($Version) Release"
git push
git tag -a v$version -m "$($script:ProjectName) Version $($Version)"
git push origin v$version
New-GitHubRelease -OwnerName $script:GithubOrg -RepositoryName $script:ProjectName -Tag "v$($Version)" -Name "v$($Version)"
}
Task Post2Discord -Description "Post a message to discord" -Action {
$Project = [xml](Get-Content -Path "$($script:Source)\$($script:ProjectName).csproj");
$Version = $Project.Project.PropertyGroup.Version.ToString();
$PackageId = $Project.Project.PropertyGroup.PackageId;
$Discord = Get-Content -Path "$($script:Root)\discord.json" | ConvertFrom-Json
$Discord.message.content = "Version $($version) of $($script:ProjectName) released. Please visit Github ($($script:Repository)/$($script:ProjectName)) or Nuget.org ($($script:NugetOrg)/$($PackageId)) 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();
$PackageId = $Project.Project.PropertyGroup.PackageId;
$createdAt = Get-Date -Format "yyyy-MM-ddTHH:mm:ss.ffffffZ"
# Authenticate
$AuthBody = Get-Content -Path "$($script:Root)\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:ProjectName) released. Please visit Github ($($script:Repository)/$($script:ProjectName)) or Nuget.org ($($script:NugetOrg)/$($PackageId)) to download."
"createdAt" = $createdAt
}
$Post = New-Object -TypeName psobject -Property @{
'repo' = $Handle
'collection' = 'app.bsky.feed.post'
record = $Record
}
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 "$($script:Source)\$($script:ProjectName).sln" -c Release
dotnet clean "$($script:Source)\$($script:ProjectName).sln" -c Debug
}
Task CreateDocumentation -Description "Create Docs" -Action {
defaultdocumentation -a "$($script:Source)\bin\Release\$($script:DotnetVersion)\$($script:ProjectName).dll" -o $script:Docs
}
Task BuildProject -Description "Build the project" -Action {
dotnet build "$($script:Root)\$($script:ProjectName)\$($script:ProjectName).csproj" -c Release
}
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 project" -Action {
$Github = (Get-Content -Path "$($script:Root)\github.json") | ConvertFrom-Json
$Credential = New-Credential -Username ignoreme -Password $Github.Token
Set-GitHubAuthentication -Credential $Credential
$Milestone = (Get-GitHubMilestone -OwnerName $script:GithubOrg -RepositoryName $script:ProjectName -State Closed | Sort-Object -Descending -Property Number)[0]
if ($Milestone)
{
[System.Text.StringBuilder]$stringbuilder = [System.Text.StringBuilder]::new()
[void]$stringbuilder.AppendLine( "# $($Milestone.title)" )
[void]$stringbuilder.AppendLine( "" )
if ($Milestone.description)
{
[void]$stringbuilder.AppendLine( "$($Milestone.description)" )
}
$i = Get-GitHubIssue -OwnerName $script:GithubOrg -RepositoryName $script:ProjectName -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 "$($script:Root)\RELEASE.md" -InputObject $stringbuilder.ToString() -Encoding ascii -Force
$Project = [xml](Get-Content -Path "$($script:Source)\$($script:ProjectName).csproj");
$ReleaseNotes = (Get-Content -Path "$($script:Root)\RELEASE.md").Replace('## ', '-').Replace('# ', '').Replace('*', '-')
$Project.Project.PropertyGroup.PackageReleaseNotes = $ReleaseNotes
$Project.Save("$($script:Source)\$($script:ProjectName).csproj")
}
}
Task TestProject -Description "Test project" -Action {
dotnet test $script:Source\$script:ProjectName.sln --logger "trx;LogFileName=$($script:Root)\$($script:TestFile)"
}
Task PackageProject -Description "Package the project" -Action {
dotnet pack $script:Source\$script:ProjectName.sln -o $script:Output -c Release
}
Task PublishProject -Description "Publish project to Nuget.org" -Action {
$Project = [xml](Get-Content -Path "$($script:Source)\$($script:ProjectName).csproj");
$PackageId = $Project.Project.PropertyGroup.PackageId;
$Version = $Project.Project.PropertyGroup.Version.ToString();
$PackageFile = "$($script:Output)\$($PackageId).$($Version).nupkg"
Write-Host "PackageFile: $($PackageFile)"
dotnet nuget push $PackageFile
}