Skip to content

Commit 06174d2

Browse files
MariusStorhaugMariusStorhaug
committed
Default module releases to namespaced labels
1 parent d5b7c72 commit 06174d2

5 files changed

Lines changed: 173 additions & 33 deletions

File tree

‎.github/actions/Get-PSModuleSettings/src/Get-PSModuleSettings.Helpers.psm1‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,47 @@ function Resolve-WorkflowEventRouting {
7979
}
8080
}
8181

82+
function Resolve-PSModulePublishSetting {
83+
<#
84+
.SYNOPSIS
85+
Resolves module publication settings and their defaults.
86+
87+
.DESCRIPTION
88+
Applies Process-PSModule defaults while preserving every consumer-provided
89+
publication and release-label mapping.
90+
91+
.OUTPUTS
92+
System.Management.Automation.PSCustomObject
93+
94+
.EXAMPLE
95+
Resolve-PSModulePublishSetting -PublishModule $settings.Publish.Module
96+
#>
97+
[CmdletBinding()]
98+
[OutputType([PSCustomObject])]
99+
param(
100+
[Parameter()]
101+
[AllowNull()]
102+
[object] $PublishModule
103+
)
104+
105+
[pscustomobject]@{
106+
Skip = $PublishModule.Skip ?? $false
107+
AutoCleanup = $PublishModule.AutoCleanup ?? $true
108+
AutoPatching = $PublishModule.AutoPatching ?? $true
109+
IncrementalPrerelease = $PublishModule.IncrementalPrerelease ?? $true
110+
DatePrereleaseFormat = $PublishModule.DatePrereleaseFormat ?? ''
111+
VersionPrefix = $PublishModule.VersionPrefix ?? 'v'
112+
MajorLabels = $PublishModule.MajorLabels ?? 'release:major'
113+
MinorLabels = $PublishModule.MinorLabels ?? 'release:minor'
114+
PatchLabels = $PublishModule.PatchLabels ?? 'release:patch'
115+
IgnoreLabels = $PublishModule.IgnoreLabels ?? 'release:skip'
116+
PrereleaseLabels = $PublishModule.PrereleaseLabels ?? 'release:pre-release'
117+
UsePRTitleAsReleaseName = $PublishModule.UsePRTitleAsReleaseName ?? $false
118+
UsePRBodyAsReleaseNotes = $PublishModule.UsePRBodyAsReleaseNotes ?? $true
119+
UsePRTitleAsNotesHeading = $PublishModule.UsePRTitleAsNotesHeading ?? $true
120+
}
121+
}
122+
82123
function Select-PullRequestForPush {
83124
<#
84125
.SYNOPSIS

‎.github/actions/Get-PSModuleSettings/src/Settings.schema.json‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,8 @@
140140
},
141141
"AutoPatching": {
142142
"type": "boolean",
143-
"description": "Automatically apply patches"
143+
"description": "Automatically apply patches",
144+
"default": true
144145
},
145146
"IncrementalPrerelease": {
146147
"type": "boolean",
@@ -156,23 +157,28 @@
156157
},
157158
"MajorLabels": {
158159
"type": "string",
159-
"description": "Comma-separated labels that trigger major version bump"
160+
"description": "Comma-separated labels that trigger major version bump",
161+
"default": "release:major"
160162
},
161163
"MinorLabels": {
162164
"type": "string",
163-
"description": "Comma-separated labels that trigger minor version bump"
165+
"description": "Comma-separated labels that trigger minor version bump",
166+
"default": "release:minor"
164167
},
165168
"PatchLabels": {
166169
"type": "string",
167-
"description": "Comma-separated labels that trigger patch version bump"
170+
"description": "Comma-separated labels that trigger patch version bump",
171+
"default": "release:patch"
168172
},
169173
"IgnoreLabels": {
170174
"type": "string",
171-
"description": "Comma-separated labels that prevent release"
175+
"description": "Comma-separated labels that prevent release",
176+
"default": "release:skip"
172177
},
173178
"PrereleaseLabels": {
174179
"type": "string",
175-
"description": "Comma-separated labels that trigger a prerelease"
180+
"description": "Comma-separated labels that trigger a prerelease",
181+
"default": "release:pre-release"
176182
},
177183
"UsePRTitleAsReleaseName": {
178184
"type": "boolean",

‎.github/actions/Get-PSModuleSettings/src/main.ps1‎

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -187,22 +187,7 @@ $settings = [pscustomobject]@{
187187
}
188188
}
189189
Publish = [pscustomobject]@{
190-
Module = [pscustomobject]@{
191-
Skip = $settings.Publish.Module.Skip ?? $false
192-
AutoCleanup = $settings.Publish.Module.AutoCleanup ?? $true
193-
AutoPatching = $settings.Publish.Module.AutoPatching ?? $true
194-
IncrementalPrerelease = $settings.Publish.Module.IncrementalPrerelease ?? $true
195-
DatePrereleaseFormat = $settings.Publish.Module.DatePrereleaseFormat ?? ''
196-
VersionPrefix = $settings.Publish.Module.VersionPrefix ?? 'v'
197-
MajorLabels = $settings.Publish.Module.MajorLabels ?? 'major, breaking'
198-
MinorLabels = $settings.Publish.Module.MinorLabels ?? 'minor, feature'
199-
PatchLabels = $settings.Publish.Module.PatchLabels ?? 'patch, fix'
200-
IgnoreLabels = $settings.Publish.Module.IgnoreLabels ?? 'NoRelease'
201-
PrereleaseLabels = $settings.Publish.Module.PrereleaseLabels ?? 'prerelease'
202-
UsePRTitleAsReleaseName = $settings.Publish.Module.UsePRTitleAsReleaseName ?? $false
203-
UsePRBodyAsReleaseNotes = $settings.Publish.Module.UsePRBodyAsReleaseNotes ?? $true
204-
UsePRTitleAsNotesHeading = $settings.Publish.Module.UsePRTitleAsNotesHeading ?? $true
205-
}
190+
Module = Resolve-PSModulePublishSetting -PublishModule $settings.Publish.Module
206191
Site = [pscustomobject]@{
207192
Skip = $settings.Publish.Site.Skip ?? $false
208193
}

‎.github/actions/Get-PSModuleSettings/tests/Get-PSModuleSettings.Helpers.Tests.ps1‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,52 @@ Describe 'Resolve-WorkflowEventRouting' {
8282
}
8383
}
8484

85+
Describe 'Resolve-PSModulePublishSetting' {
86+
It 'uses the canonical release-label defaults' {
87+
$result = Resolve-PSModulePublishSetting -PublishModule $null
88+
89+
$result.AutoPatching | Should -BeTrue
90+
$result.MajorLabels | Should -BeExactly 'release:major'
91+
$result.MinorLabels | Should -BeExactly 'release:minor'
92+
$result.PatchLabels | Should -BeExactly 'release:patch'
93+
$result.PrereleaseLabels | Should -BeExactly 'release:pre-release'
94+
$result.IgnoreLabels | Should -BeExactly 'release:skip'
95+
}
96+
97+
It 'preserves consumer-controlled release settings' {
98+
$publishModule = [pscustomobject]@{
99+
AutoPatching = $false
100+
MajorLabels = 'custom:major'
101+
MinorLabels = 'custom:minor'
102+
PatchLabels = 'custom:patch'
103+
PrereleaseLabels = 'custom:pre-release'
104+
IgnoreLabels = 'custom:skip'
105+
}
106+
107+
$result = Resolve-PSModulePublishSetting -PublishModule $publishModule
108+
109+
$result.AutoPatching | Should -BeFalse
110+
$result.MajorLabels | Should -BeExactly 'custom:major'
111+
$result.MinorLabels | Should -BeExactly 'custom:minor'
112+
$result.PatchLabels | Should -BeExactly 'custom:patch'
113+
$result.PrereleaseLabels | Should -BeExactly 'custom:pre-release'
114+
$result.IgnoreLabels | Should -BeExactly 'custom:skip'
115+
}
116+
117+
It 'declares the same canonical defaults in the settings schema' {
118+
$schemaPath = Join-Path -Path $PSScriptRoot -ChildPath '../src/Settings.schema.json'
119+
$schema = Get-Content -Path $schemaPath -Raw | ConvertFrom-Json
120+
$moduleProperties = $schema.properties.Publish.properties.Module.properties
121+
122+
$moduleProperties.AutoPatching.default | Should -BeTrue
123+
$moduleProperties.MajorLabels.default | Should -BeExactly 'release:major'
124+
$moduleProperties.MinorLabels.default | Should -BeExactly 'release:minor'
125+
$moduleProperties.PatchLabels.default | Should -BeExactly 'release:patch'
126+
$moduleProperties.PrereleaseLabels.default | Should -BeExactly 'release:pre-release'
127+
$moduleProperties.IgnoreLabels.default | Should -BeExactly 'release:skip'
128+
}
129+
}
130+
85131
Describe 'Select-PullRequestForPush' {
86132
It 'selects the merged PR whose merge commit matches the pushed commit' {
87133
$pullRequests = @(

‎.github/actions/Resolve-PSModuleVersion/tests/Resolve-PSModuleVersion.Helpers.Tests.ps1‎

Lines changed: 73 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,23 @@ BeforeAll {
3535

3636
# The release type resolved from the pull request labels.
3737
[Parameter()]
38-
[string] $ReleaseType = 'Release'
38+
[string] $ReleaseType = 'Release',
39+
40+
# Labels indicating no release.
41+
[Parameter()]
42+
[string[]] $IgnoreLabels = @('release:skip'),
43+
44+
# Labels indicating a major release.
45+
[Parameter()]
46+
[string[]] $MajorLabels = @('release:major'),
47+
48+
# Labels indicating a minor release.
49+
[Parameter()]
50+
[string[]] $MinorLabels = @('release:minor'),
51+
52+
# Labels indicating a patch release.
53+
[Parameter()]
54+
[string[]] $PatchLabels = @('release:patch')
3955
)
4056

4157
[PSCustomObject]@{
@@ -44,10 +60,10 @@ BeforeAll {
4460
DatePrereleaseFormat = $DatePrereleaseFormat
4561
VersionPrefix = $VersionPrefix
4662
ReleaseType = $ReleaseType
47-
IgnoreLabels = @('NoRelease')
48-
MajorLabels = @('major')
49-
MinorLabels = @('minor')
50-
PatchLabels = @('patch')
63+
IgnoreLabels = $IgnoreLabels
64+
MajorLabels = $MajorLabels
65+
MinorLabels = $MinorLabels
66+
PatchLabels = $PatchLabels
5167
}
5268
}
5369

@@ -495,7 +511,7 @@ Describe 'Resolve-PSModuleVersion' {
495511
PullRequest = @{
496512
Number = 390
497513
HeadRef = 'feature/push-release'
498-
Labels = @('minor')
514+
Labels = @('release:minor')
499515
}
500516
}
501517
} | ConvertTo-Json -Depth 5
@@ -504,7 +520,7 @@ Describe 'Resolve-PSModuleVersion' {
504520

505521
$result.Number | Should -Be 390
506522
$result.HeadRef | Should -Be 'feature/push-release'
507-
$result.Labels | Should -Be @('minor')
523+
$result.Labels | Should -Be @('release:minor')
508524
}
509525

510526
It 'creates default patch context for a direct default-branch push' {
@@ -544,7 +560,7 @@ Describe 'Resolve-PSModuleVersion' {
544560

545561
It 'does not validate cleanup-only pull request labels' {
546562
$result = Resolve-ReleaseDecision -Configuration (Get-TestConfiguration -ReleaseType None) `
547-
-PullRequest ([pscustomobject]@{ HeadRef = 'feature'; Labels = @('NoRelease', 'patch') })
563+
-PullRequest ([pscustomobject]@{ HeadRef = 'feature'; Labels = @('release:skip', 'release:patch') })
548564

549565
$result.ShouldPublish | Should -BeFalse
550566
$result.HasVersionBump | Should -BeFalse
@@ -553,15 +569,61 @@ Describe 'Resolve-PSModuleVersion' {
553569
It 'rejects multiple version labels' {
554570
{
555571
Resolve-ReleaseDecision -Configuration (Get-TestConfiguration) `
556-
-PullRequest ([pscustomobject]@{ HeadRef = 'main'; Labels = @('major', 'patch') })
572+
-PullRequest ([pscustomobject]@{ HeadRef = 'main'; Labels = @('release:major', 'release:patch') })
557573
} | Should -Throw '*Conflicting version labels*'
558574
}
559575

560-
It 'rejects a NoRelease label combined with a version label' {
576+
It 'rejects release:skip combined with a version label' {
561577
{
562578
Resolve-ReleaseDecision -Configuration (Get-TestConfiguration) `
563-
-PullRequest ([pscustomobject]@{ HeadRef = 'main'; Labels = @('NoRelease', 'patch') })
579+
-PullRequest ([pscustomobject]@{ HeadRef = 'main'; Labels = @('release:skip', 'release:patch') })
564580
} | Should -Throw '*ignore label cannot be combined*'
565581
}
582+
583+
It 'honors the canonical <Bump> default' -ForEach @(
584+
@{ Bump = 'Major'; Label = 'release:major'; Flag = 'MajorRelease' }
585+
@{ Bump = 'Minor'; Label = 'release:minor'; Flag = 'MinorRelease' }
586+
@{ Bump = 'Patch'; Label = 'release:patch'; Flag = 'PatchRelease' }
587+
) {
588+
$pullRequest = [pscustomobject]@{
589+
HeadRef = 'main'
590+
Labels = @($Label)
591+
}
592+
593+
$result = Resolve-ReleaseDecision -Configuration (Get-TestConfiguration) -PullRequest $pullRequest
594+
595+
$result.$Flag | Should -BeTrue
596+
$result.ShouldPublish | Should -BeTrue
597+
}
598+
599+
It 'honors the configured <Bump> label mapping' -ForEach @(
600+
@{ Bump = 'Major'; Setting = 'MajorLabels'; Label = 'custom:major'; Flag = 'MajorRelease' }
601+
@{ Bump = 'Minor'; Setting = 'MinorLabels'; Label = 'custom:minor'; Flag = 'MinorRelease' }
602+
@{ Bump = 'Patch'; Setting = 'PatchLabels'; Label = 'custom:patch'; Flag = 'PatchRelease' }
603+
) {
604+
$configuration = Get-TestConfiguration
605+
$configuration.$Setting = @($Label)
606+
$pullRequest = [pscustomobject]@{
607+
HeadRef = 'main'
608+
Labels = @($Label)
609+
}
610+
611+
$result = Resolve-ReleaseDecision -Configuration $configuration -PullRequest $pullRequest
612+
613+
$result.$Flag | Should -BeTrue
614+
$result.ShouldPublish | Should -BeTrue
615+
}
616+
617+
It 'honors a configured ignore label' {
618+
$configuration = Get-TestConfiguration -IgnoreLabels @('custom:skip')
619+
$pullRequest = [pscustomobject]@{
620+
HeadRef = 'main'
621+
Labels = @('custom:skip')
622+
}
623+
624+
$result = Resolve-ReleaseDecision -Configuration $configuration -PullRequest $pullRequest
625+
626+
$result.ShouldPublish | Should -BeFalse
627+
}
566628
}
567629
}

0 commit comments

Comments
 (0)