Skip to content

🪲 [Fix]: Only resolve a prerelease for open pull requests #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🪲 [Fix]: Only resolve a prerelease for open pull requests #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 57 additions & 30 deletions scripts/Resolve-PSModuleVersion.Helpers.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,9 @@ function Get-GitHubPullRequest {
returns $null and the caller resolves the current version without a version bump.

.OUTPUTS
PSCustomObject with HeadRef and Labels properties for a pull_request event, or
$null when the event has no pull request (non-PR events).
PSCustomObject with HeadRef, Labels, and IsOpen properties for a pull_request event, or
$null when the event has no pull request (non-PR events). IsOpen is $true only while the
pull request is open (under review); it is $false once the PR is merged or closed.

.EXAMPLE
$pullRequest = Get-GitHubPullRequest
Expand All @@ -160,16 +161,25 @@ function Get-GitHubPullRequest {
$labels = @()
$labels += $pr.labels.name

# A pull request is OPEN while it is under review (opened/reopened/synchronize/labeled).
# Once it is merged or closed its state becomes 'closed'. Only an open pull request may
# resolve to a prerelease; a merged/closed PR - like a push to the default branch - never
# does. Default to not-open when state is missing so we never accidentally prerelease.
$isOpen = $pr.state -eq 'open'

Write-Host '-------------------------------------------------'
Write-Host ([PSCustomObject]@{
PRHeadRef = $pr.head.ref
State = $pr.state
IsOpen = $isOpen
Labels = $labels -join ', '
} | Format-List | Out-String)
Write-Host '-------------------------------------------------'

[PSCustomObject]@{
HeadRef = $pr.head.ref
Labels = $labels
IsOpen = $isOpen
}
}
}
Expand All @@ -181,7 +191,12 @@ function Resolve-ReleaseDecision {

.DESCRIPTION
Evaluates the PR labels against the configured label categories and release type
to produce a complete release decision.
to produce a complete release decision. A prerelease - whether a published prerelease or
a non-published preview - is only ever resolved for an OPEN pull request, so the artifact
built during review can never masquerade as a stable release before the merge decision is
made. Once a PR is merged or closed (and likewise for a push to the default branch, which
the workflow treats the same as a merged PR) the outcome is final: a full release, or the
current version unchanged - never a prerelease.

.OUTPUTS
PSCustomObject with ShouldPublish, CreateRelease, CreatePrerelease, MajorRelease,
Expand All @@ -208,6 +223,7 @@ function Resolve-ReleaseDecision {
$prereleaseName = $PullRequest.HeadRef -replace '[^a-zA-Z0-9]'
$labels = $PullRequest.Labels
$releaseType = $Configuration.ReleaseType
$isOpenPullRequest = [bool]$PullRequest.IsOpen

$validReleaseTypes = @('Release', 'Prerelease', 'None')
if ([string]::IsNullOrWhiteSpace($releaseType)) {
Expand All @@ -217,15 +233,7 @@ function Resolve-ReleaseDecision {
throw "Invalid ReleaseType: [$releaseType]. Valid values are: $($validReleaseTypes -join ', ')"
}

$createRelease = $releaseType -eq 'Release'
$createPrerelease = $releaseType -eq 'Prerelease'
$shouldPublish = $createRelease -or $createPrerelease

$ignoreRelease = ($labels | Where-Object { $Configuration.IgnoreLabels -contains $_ }).Count -gt 0
if ($ignoreRelease -and $shouldPublish) {
Write-Host 'Ignoring release creation due to ignore label.'
$shouldPublish = $false
}

# Always evaluate the version-bump labels so the resolved version reflects what WOULD be
# created, regardless of whether this run publishes. ReleaseType (and the prerelease label
Expand All @@ -235,32 +243,51 @@ function Resolve-ReleaseDecision {
$patchRelease = (
(($labels | Where-Object { $Configuration.PatchLabels -contains $_ }).Count -gt 0) -or $Configuration.AutoPatching
) -and -not $majorRelease -and -not $minorRelease

$hasVersionBump = $majorRelease -or $minorRelease -or $patchRelease
if (-not $hasVersionBump) {
# No explicit bump label and no AutoPatching: still resolve a patch version so the run
# can preview what it would create, but do not publish a full release for an unlabeled change.
Write-Host 'No version bump label and AutoPatching disabled; previewing a patch version without publishing.'
$patchRelease = $true
$hasVersionBump = $true
$shouldPublish = $false
}

# Anything that is not a published full release is surfaced as a prerelease - either a
# published prerelease (ShouldPublish) or a non-published preview.
if (-not $shouldPublish) {
# A prerelease - whether a published prerelease or a non-published preview - only makes
# sense while a pull request is OPEN. It lets the artifact built during review carry a
# prerelease tag so it can never be mistaken for a stable release before the merge decision
# is made. Once the change lands on the default branch the outcome is final: a merged pull
# request publishes a full release (or, when nothing warrants one, nothing at all), and a
# push to the default branch is treated the same as a merged pull request. A merge or push
# therefore never resolves to a prerelease.
if ($isOpenPullRequest) {
# Open pull request: always carry a prerelease tag. ReleaseType 'Prerelease' (the
# prerelease label) publishes it; otherwise it is a non-published preview. An ignore
# label only suppresses publishing - the reviewed artifact still stays a prerelease.
$createRelease = $false
$createPrerelease = $true
$shouldPublish = ($releaseType -eq 'Prerelease') -and -not $ignoreRelease
if (-not $hasVersionBump) {
Write-Host 'No version bump label and AutoPatching disabled; previewing a patch version.'
$patchRelease = $true
$hasVersionBump = $true
}
} else {
# Merged/closed pull request or a push to the default branch: never a prerelease.
$createPrerelease = $false
$createRelease = ($releaseType -eq 'Release') -and -not $ignoreRelease -and $hasVersionBump
$shouldPublish = $createRelease
if (-not $createRelease) {
Write-Host 'No open pull request and nothing to release; keeping the current version.'
$majorRelease = $false
$minorRelease = $false
$patchRelease = $false
$hasVersionBump = $false
}
}

Write-Host '-------------------------------------------------'
Write-Host ([PSCustomObject]@{
ReleaseType = $releaseType
ShouldPublish = $shouldPublish
CreateRelease = $createRelease
CreatePrerelease = $createPrerelease
Major = $majorRelease
Minor = $minorRelease
Patch = $patchRelease
ReleaseType = $releaseType
IsOpenPullRequest = $isOpenPullRequest
ShouldPublish = $shouldPublish
CreateRelease = $createRelease
CreatePrerelease = $createPrerelease
Major = $majorRelease
Minor = $minorRelease
Patch = $patchRelease
} | Format-List | Out-String)
Write-Host '-------------------------------------------------'

Expand Down
Loading