Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
PSReadLine/PSReadLine.build.ps1 at master · PowerShell/PSReadLine · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
See all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
PowerShell
PSReadLine
Repository navigation
Code
Issues
276
(276)
Pull requests
25
(25)
Discussions
Actions
Projects
Wiki
Security and quality
Insights
More
items
Files
Expand file tree
master
Breadcrumbs
PSReadLine
/
PSReadLine.build.ps1
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
254 lines (211 loc) · 8.2 KB
master
Breadcrumbs
PSReadLine
/
PSReadLine.build.ps1
Copy path
Top
File metadata and controls
Code
Blame
254 lines (211 loc) · 8.2 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
#
#
To build, make sure you've installed InvokeBuild
#
Install-Module -Repository PowerShellGallery -Name InvokeBuild -RequiredVersion 3.1.0
#
#
Then:
#
Invoke-Build
#
#
Or:
#
Invoke-Build -Task ZipRelease
#
#
Or:
#
Invoke-Build -Configuration Debug
#
#
etc.
#
[
CmdletBinding
()]
param
(
[
ValidateSet
(
"
Debug
"
,
"
Release
"
)]
[
string
]
$Configuration
=
(property Configuration Release)
,
[
switch
]
$CheckHelpContent
)
Import-Module
"
$PSScriptRoot
/tools/helper.psm1
"
#
Dynamically read target framework from project file
$csprojPath
=
"
$PSScriptRoot
/PSReadLine/PSReadLine.csproj
"
[
xml
]
$csproj
=
Get-Content
$csprojPath
$targetFramework
=
$csproj
.Project.PropertyGroup.TargetFramework
|
Where-Object
{
$_
}
|
Select-Object
-
First
1
if
(
-not
$targetFramework
) {
throw
"
Could not determine TargetFramework from
$csprojPath
"
}
Write-Verbose
"
Target framework:
$targetFramework
"
#
Final bits to release go here
$targetDir
=
"
bin/
$Configuration
/PSReadLine
"
function
ConvertTo-CRLF
([
string
]
$text
) {
$text
.Replace
(
"
`r`n
"
,
"
`n
"
).Replace(
"
`n
"
,
"
`r`n
"
)
}
$binaryModuleParams
=
@
{
Inputs
=
{
Get-ChildItem
PSReadLine
/*
.cs
,
PSReadLine
/
PSReadLine.csproj
,
PSReadLine
/
PSReadLineResources.resx }
Outputs
=
"
PSReadLine/bin/
$Configuration
/
$targetFramework
/Microsoft.PowerShell.PSReadLine.dll
"
}
$xUnitTestParams
=
@
{
Inputs
=
{
Get-ChildItem
test
/*
.cs
,
test
/*
.json
,
test
/
PSReadLine.Tests.csproj }
Outputs
=
"
test/bin/
$Configuration
/
$targetFramework
/PSReadLine.Tests.dll
"
}
<#
Synopsis: Build main binary module
#>
task BuildMainModule
@binaryModuleParams
{
exec { dotnet publish
-
c
$Configuration
PSReadLine\PSReadLine.csproj }
}
<#
Synopsis: Build xUnit tests
#>
task BuildXUnitTests
@xUnitTestParams
{
exec { dotnet publish
-f
$targetFramework
-
c
$Configuration
test }
}
<#
Synopsis: Run the unit tests
#>
task RunTests BuildMainModule
,
BuildXUnitTests
,
{
Write-Verbose
"
Run tests targeting
$targetFramework
...
"
Start-TestRun
-
Configuration
$Configuration
-
Framework
$targetFramework
}
<#
Synopsis: Check if the help content is in sync.
#>
task CheckHelpContent
-
If
$CheckHelpContent
{
#
This step loads the dll that was just built, so only do that in another process
#
so the file isn't locked in any way for the rest of the build.
$psExePath
=
Get-PSExePath
&
$psExePath
-
NoProfile
-
NonInteractive
-
File
$PSScriptRoot
/
tools
/
CheckHelp.ps1
$Configuration
assert (
$LASTEXITCODE
-eq
0
)
"
Checking help and function signatures failed
"
}
<#
Synopsis: Copy all of the files that belong in the module to one place in the layout for installation
#>
task LayoutModule BuildMainModule
,
{
if
(
-not
(
Test-Path
$targetDir
-
PathType Container)) {
New-Item
$targetDir
-
ItemType Directory
-
Force
>
$null
}
$extraFiles
=
'
License.txt
'
,
'
PSReadLine/Changes.txt
'
,
'
PSReadLine/SamplePSReadLineProfile.ps1
'
,
'
PSReadLine/PSReadLine.format.ps1xml
'
,
'
PSReadLine/PSReadLine.psm1
'
foreach
(
$file
in
$extraFiles
) {
#
ensure files have \r\n line endings as the signing tool only uses those endings to avoid mixed endings
$content
=
Get-Content
-
Path
$file
-
Raw
Set-Content
-
Path (
Join-Path
$targetDir
(
Split-Path
$file
-
Leaf))
-
Value (
ConvertTo-CRLF
$content
)
-
Force
}
$binPath
=
"
PSReadLine/bin/
$Configuration
/
$targetFramework
/publish
"
Copy-Item
$binPath
/
Microsoft.PowerShell.PSReadLine.dll
$targetDir
Copy-Item
$binPath
/
Microsoft.PowerShell.Pager.dll
$targetDir
if
(
$Configuration
-eq
'
Debug
'
) {
Copy-Item
$binPath
/*
.pdb
$targetDir
}
#
Copy module manifest, but fix the version to match what we've specified in the binary module.
$moduleManifestContent
=
ConvertTo-CRLF
(
Get-Content
-
Path
'
PSReadLine/PSReadLine.psd1
'
-
Raw)
$versionInfo
=
(
Get-ChildItem
-
Path
$targetDir
/
Microsoft.PowerShell.PSReadLine.dll).VersionInfo
$version
=
$versionInfo
.FileVersion
$semVer
=
$versionInfo
.ProductVersion
#
dotnet build may add the Git commit hash to the 'ProductVersion' attribute with this format: +<commit-hash>.
if
(
$semVer
-match
"
(.*)-([^\+]*)(?:\+.*)?
"
) {
#
Make sure versions match
if
(
$matches
[
1
]
-ne
$version
) {
throw
"
AssemblyFileVersion mismatch with AssemblyInformationalVersion
"
}
$prerelease
=
$matches
[
2
]
#
Put the prerelease tag in private data, along with the project URI.
$privateDataSection
=
"
PrivateData = @{ PSData = @{ Prerelease = '
$prerelease
'; ProjectUri = 'https://github.com/PowerShell/PSReadLine' } }
"
}
else
{
#
Put the project URI in private data.
$privateDataSection
=
"
PrivateData = @{ PSData = @{ ProjectUri = 'https://github.com/PowerShell/PSReadLine' } }
"
}
$moduleManifestContent
=
[
regex
]::Replace(
$moduleManifestContent
,
"
}
"
,
"
${privateDataSection}
$
(
[
System.Environment
]::Newline
)
}
"
)
$moduleManifestContent
=
[
regex
]::Replace(
$moduleManifestContent
,
"
ModuleVersion = '.*'
"
,
"
ModuleVersion = '
$version
'
"
)
$moduleManifestContent
|
Set-Content
-
Path
$targetDir
/
PSReadLine.psd1
#
Make sure we don't ship any read-only files
foreach
(
$file
in
(
Get-ChildItem
-
Recurse
-
File
$targetDir
)) {
$file
.IsReadOnly
=
$false
}
}
,
CheckHelpContent
<#
Synopsis: Zip up the binary for release.
#>
task ZipRelease LayoutModule
,
{
Compress-Archive
-
Force
-
LiteralPath
$targetDir
-
DestinationPath
"
bin/
$Configuration
/PSReadLine.zip
"
}
<#
Synopsis: Install newly built PSReadLine
#>
task Install LayoutModule
,
{
function
Install
(
$InstallDir
) {
if
(
!
(
Test-Path
-
Path
$InstallDir
))
{
New-Item
-
ItemType Directory
-
Force
$InstallDir
}
try
{
if
(
Test-Path
-
Path
$InstallDir
\PSReadLine)
{
Remove-Item
-
Recurse
-
Force
$InstallDir
\PSReadLine
-
ErrorAction Stop
}
Copy-Item
-
Recurse
$targetDir
$InstallDir
}
catch
{
Write-Error
-
Message
"
Can't install, module is probably in use.
"
}
}
Install
"
$HOME
\Documents\WindowsPowerShell\Modules
"
Install
"
$HOME
\Documents\PowerShell\Modules
"
}
<#
Synopsis: Publish to PSGallery
#>
task Publish
-
If (
$Configuration
-eq
'
Release
'
) {
$binDir
=
"
$PSScriptRoot
/bin/Release/PSReadLine
"
#
Check signatures before publishing
Get-ChildItem
-
Recurse
$binDir
-
Include
"
*.dll
"
,
"
*.ps*1
"
|
Get-AuthenticodeSignature
|
ForEach-Object
{
if
(
$_
.Status
-ne
'
Valid
'
) {
throw
"
$
(
$_
.Path
)
is not signed
"
}
if
(
$_
.SignerCertificate.Subject
-notmatch
'
CN=Microsoft Corporation.*
'
) {
throw
"
$
(
$_
.Path
)
is not signed with a Microsoft signature
"
}
}
#
Check newlines in signed files before publishing
Get-ChildItem
-
Recurse
$binDir
-
Include
"
*.ps*1
"
|
Get-AuthenticodeSignature
|
ForEach-Object
{
$lines
=
(
Get-Content
$_
.Path
|
Measure-Object
).Count
$fileBytes
=
[
System.IO.File
]::ReadAllBytes(
$_
.Path
)
$toMatch
=
(
$fileBytes
|
ForEach-Object
{
"
{0:X2}
"
-f
$_
})
-join
'
;
'
$crlf
=
([
regex
]::Matches(
$toMatch
,
"
;0D;0A
"
)
|
Measure-Object
).Count
if
(
$lines
-ne
$crlf
) {
throw
"
$
(
$_
.Path
)
appears to have mixed newlines
"
}
}
$manifest
=
Import-PowerShellDataFile
$binDir
/
PSReadLine.psd1
$version
=
$manifest
.ModuleVersion
if
(
$null
-ne
$manifest
.PrivateData
)
{
$psdata
=
$manifest
.PrivateData
[
'
PSData
'
]
if
(
$null
-ne
$psdata
)
{
$prerelease
=
$psdata
[
'
Prerelease
'
]
if
(
$null
-ne
$prerelease
)
{
$version
=
$version
+
'
-
'
+
$prerelease
}
}
}
$yes
=
Read-Host
"
Publish version
$version
(y/n)
"
if
(
$yes
-ne
'
y
'
) {
throw
"
Publish aborted
"
}
$nugetApiKey
=
Read-Host
-
AsSecureString
"
Nuget api key for PSGallery
"
$publishParams
=
@
{
Path
=
$binDir
NuGetApiKey
=
[
PSCredential
]::new(
"
user
"
,
$nugetApiKey
).GetNetworkCredential().Password
Repository
=
"
PSGallery
"
ReleaseNotes
=
(
Get-Content
-
Raw
$binDir
/
Changes.txt)
ProjectUri
=
'
https://github.com/PowerShell/PSReadLine
'
}
Publish-Module
@publishParams
}
<#
Synopsis: Remove temporary items.
#>
task
Clean
{
git
clean
-
fdx
}
<#
Synopsis: Default build rule - build and create module layout
#>
task
.
LayoutModule
,
RunTests
You can’t perform that action at this time.