Files
azure-sdk-for-js/eng/scripts/check-external-dependency.ps1
61718144a0 Skip prerelease versions and prevent duplicate weekly dependency-upgrade issues (#38770)
### Packages impacted by this PR

- eng/scripts (weekly automation dependency check)

### Issues associated with this PR

- #38763

### Describe the problem that is addressed by this PR

Weekly dependency-upgrade automation was treating prerelease tags (for
example `5.0.0-beta.3`) as actionable upgrades and filing upgrade issues
for them.

This PR limits issue creation to stable releases.

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: jeremymeng <[email protected]>
2026-07-17 15:58:16 -07:00

146 lines
5.8 KiB
PowerShell

[CmdletBinding(SupportsShouldProcess = $true)]
param (
[Parameter(Mandatory = $true)]
[string]$AuthToken,
[Parameter(Mandatory = $true)]
[string]$RepoOwner,
[Parameter(Mandatory = $true)]
[string]$RepoName
)
# This script will reset the repo and any changes in tracked files will be lost.
$dependencyUpgradeLabel = "dependency-upgrade-required"
$deprecatedDependency = "Deprecated-Dependency"
$RepoRoot = Resolve-Path -Path "${PSScriptRoot}/../.."
Write-Host "Repo root: $RepoRoot"
$EngCommonScriptsPath = Join-Path (Resolve-Path "${PSScriptRoot}/..") "common" "scripts"
. (Join-Path $EngCommonScriptsPath common.ps1)
$ghIssues = Get-GitHubIssues -RepoOwner $RepoOwner -RepoName $RepoName -Labels $dependencyUpgradeLabel -AuthToken $AuthToken
# Check and return if an issue already exists to upgrade the package
function Get-GithubIssue($IssueTitle) {
foreach ($issue in $ghIssues) {
if ($issue.title -eq $IssueTitle) {
return $issue
}
}
return $null
}
# Create new issue if none exists for the package. or update current one if an issue exists
function Set-GitHubIssue($Package) {
$pkgName = $Package.Name
$issueTitle = "Dependency package $pkgName has a new version available"
$issueDesc = "We have identified a dependency on version $($Package.OldVersion) of [$pkgName](https://www.npmjs.com/package/$pkgName). "
$labels = $dependencyUpgradeLabel
if ($Package.IsDeprecated) {
$issueDesc += "Version $($Package.OldVersion) of $pkgName has been deprecated.`n"
$labels += ",$deprecatedDependency"
}
$issueDesc += "A new version ($($Package.NewVersion)) is available for upgrade.`n`nFollowing are the steps to upgrade package dependency.`n
1. Understand the breaking changes between the version being used and the version you want to upgrade to.`n
2. Identify all packages that take a dependency on this package.`n
3. Go to the root folder for each such package (/sdk/service-name/package-name) and update package.json to have the new version.`n
4. Run 'pnpm install' to ensure the new version is pulled in.`n
5. Make relevant changes to absorb the breaking changes.`n
6. Repeat steps 3 to 5 for each of the packages that have a dependency on this package."
$issue = Get-GithubIssue -IssueTitle $issueTitle
if ($issue) {
if ($issue.body -ne $issueDesc) {
# Copy over current labels to avoid removing manually tagged labels
foreach($lbl in $issue.labels)
{
$labels += ",$($lbl.name)"
}
Write-Host "Updating existing issue $($issue.number). Labels: $($labels)"
$oldIssue = Update-GitHubIssue -RepoOwner $RepoOwner -RepoName $RepoName -AuthToken $AuthToken -IssueNumber $issue.number -Body $issueDesc -Labels $labels
Write-Host "Updated existing issue $($oldIssue.number)"
}
else {
Write-Host "Found existing issue for package $($Package.Name)"
}
}
else {
write-Host "Creating issue for $pkgName"
$newIssue = New-GitHubIssue -RepoOwner $RepoOwner -RepoName $RepoName -AuthToken $AuthToken -Title $issueTitle -Description $issueDesc
if ($newIssue) {
$out = Add-GitHubIssueLabels -RepoOwner $RepoOwner -RepoName $RepoName -AuthToken $AuthToken -Labels $labels -IssueNumber $newIssue.number
}
}
}
function Test-IsPreReleaseVersion {
param (
[string]$Version
)
if ([string]::IsNullOrWhiteSpace($Version)) {
return $false
}
$normalizedVersion = $Version.Trim()
if ($normalizedVersion.StartsWith("v", [System.StringComparison]::OrdinalIgnoreCase)) {
$normalizedVersion = $normalizedVersion.Substring(1)
}
try {
$semanticVersion = [System.Management.Automation.SemanticVersion]::Parse($normalizedVersion)
return -not [string]::IsNullOrEmpty($semanticVersion.PreReleaseLabel)
}
catch {
# Fallback for version strings SemanticVersion cannot parse; pattern matches SemVer prerelease forms (e.g. 1.2.3-beta.1+build.123).
$semVerPreReleasePattern = '^\d+\.\d+\.\d+-[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*(?:\+[0-9A-Za-z-.]+)?$'
return $normalizedVersion -match $semVerPreReleasePattern
}
}
# do a update first so we don't report on upgrades that will be in azure sdk bot PR
Write-Host "Running pnpm update --recursive --no-save --no-color"
pnpm update --recursive --no-save --no-color
Write-Host "Running 'pnpm --filter=!@azure/arm-* --filter=!@azure-rest/arm-* outdated --format json --recursive --no-color'"
$env:NODE_OPTIONS = "--max-old-space-size=16384"
$pnpmOutdatedOutput = & pnpm --filter=!@azure/arm-* --filter=!@azure-rest/arm-* outdated --format json --recursive --no-color | Where-Object { -not ($_.Contains("[WARN]", [System.StringComparison]::OrdinalIgnoreCase)) }
try {
$pnpmOutdatedJson = $pnpmOutdatedOutput -join "`n"
$availableUpdates = $pnpmOutdatedJson | ConvertFrom-Json
}
catch {
Write-Host "Error parsing pnpm outdated output as JSON. Output was:"
Write-Host ($pnpmOutdatedOutput -join "`n")
throw
}
foreach ($update in $availableUpdates.PSObject.Properties) {
if ($update.Name -notmatch '^@azure') {
$p = New-Object PSObject -Property @{
Name = $update.Name
OldVersion = $update.Value.'wanted'
NewVersion = $update.Value.'latest'
IsDeprecated = $update.Value.'isDeprecated'
}
if ($null -ne $p.OldVersion -and $null -ne $p.NewVersion -and $p.OldVersion -ne $p.NewVersion) {
# Ignore prerelease-only upgrades (beta/rc/etc.) so weekly automation files issues only for stable releases.
if (Test-IsPreReleaseVersion -Version $p.NewVersion) {
Write-Host "Skipping pre-release version for $($p.Name): $($p.NewVersion). Weekly dependency issues are filed for stable releases only."
continue
}
Write-Host $update.Name, $update.Value.'wanted', $update.Value.'latest'
Set-GitHubIssue -Package $p
Start-Sleep -s 5
}
}
}
Write-Host "Verified and filed issues"
exit 0