Include instructions to upgrade package dependency in auto filed issues (#20099)
* Update issue description and labels for package dependency upgrade issues
This commit is contained in:
Родитель
35757be24f
Коммит
8d27ce2148
|
@ -13,6 +13,7 @@ param (
|
||||||
# This script will reset the repo and any changes in tracked files will be lost.
|
# This script will reset the repo and any changes in tracked files will be lost.
|
||||||
|
|
||||||
$dependencyUpgradeLabel = "dependency-upgrade-required"
|
$dependencyUpgradeLabel = "dependency-upgrade-required"
|
||||||
|
$deprecatedDependency = "Deprecated-Dependency"
|
||||||
$dependencyRegex = "^\+\s(?<pkg>[\S]*)\s(?<version>[\S]*)\s\((?<newVersion>[0-9\.a-b]*).*\)\s?(?<deprecated>deprecated)?"
|
$dependencyRegex = "^\+\s(?<pkg>[\S]*)\s(?<version>[\S]*)\s\((?<newVersion>[0-9\.a-b]*).*\)\s?(?<deprecated>deprecated)?"
|
||||||
$RepoRoot = Resolve-Path -Path "${PSScriptRoot}/../.."
|
$RepoRoot = Resolve-Path -Path "${PSScriptRoot}/../.."
|
||||||
Write-Host "Repo root: $RepoRoot"
|
Write-Host "Repo root: $RepoRoot"
|
||||||
|
@ -39,17 +40,24 @@ function Get-GithubIssue($IssueTitle) {
|
||||||
function Set-GitHubIssue($Package) {
|
function Set-GitHubIssue($Package) {
|
||||||
$pkgName = $Package.Name
|
$pkgName = $Package.Name
|
||||||
$issueTitle = "Dependency package $pkgName has a new version available"
|
$issueTitle = "Dependency package $pkgName has a new version available"
|
||||||
$issueDesc = "We have identified a dependency on $pkgName ($($Package.OldVersion)). "
|
$issueDesc = "We have identified a dependency on version $($Package.OldVersion) of $pkgName. "
|
||||||
|
$labels = $dependencyUpgradeLabel
|
||||||
if ($Package.IsDeprecated) {
|
if ($Package.IsDeprecated) {
|
||||||
$issueDesc += "Version $($Package.OldVersion) of $pkgName has been deprecated.`n"
|
$issueDesc += "Version $($Package.OldVersion) of $pkgName has been deprecated.`n"
|
||||||
|
$labels += ",$deprecatedDependency"
|
||||||
}
|
}
|
||||||
$issueDesc += "A new version ($($Package.NewVersion)) is available now."
|
$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 rush update 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
|
$issue = Get-GithubIssue -IssueTitle $issueTitle
|
||||||
if ($issue) {
|
if ($issue) {
|
||||||
if ($issue.body -ne $issueDesc) {
|
if ($issue.body -ne $issueDesc) {
|
||||||
$oldIssue = Update-GitHubIssue -RepoOwner $RepoOwner -RepoName $RepoName -AuthToken $AuthToken -IssueNumber $issue.number -Body $issueDesc
|
$oldIssue = Update-GitHubIssue -RepoOwner $RepoOwner -RepoName $RepoName -AuthToken $AuthToken -IssueNumber $issue.number -Body $issueDesc -Labels $labels
|
||||||
Write-Host "Updated existing issue $($oldIssue.number)"
|
Write-Host "Updated existing issue $($oldIssue.number)"
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
|
@ -60,7 +68,7 @@ function Set-GitHubIssue($Package) {
|
||||||
write-Host "Creating issue for $pkgName"
|
write-Host "Creating issue for $pkgName"
|
||||||
$newIssue = New-GitHubIssue -RepoOwner $RepoOwner -RepoName $RepoName -AuthToken $AuthToken -Title $issueTitle -Description $issueDesc
|
$newIssue = New-GitHubIssue -RepoOwner $RepoOwner -RepoName $RepoName -AuthToken $AuthToken -Title $issueTitle -Description $issueDesc
|
||||||
if ($newIssue) {
|
if ($newIssue) {
|
||||||
$out = Add-GitHubIssueLabels -RepoOwner $RepoOwner -RepoName $RepoName -AuthToken $AuthToken -Labels $dependencyUpgradeLabel -IssueNumber $newIssue.number
|
$out = Add-GitHubIssueLabels -RepoOwner $RepoOwner -RepoName $RepoName -AuthToken $AuthToken -Labels $labels -IssueNumber $newIssue.number
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Загрузка…
Ссылка в новой задаче