mirror of
https://github.com/hanzoai/azure-sdk-for-js.git
synced 2026-10-30 19:51:51 +00:00
https://github.com/Azure/azure-sdk-tools/issues/12383 1. add script for update change log content and version update. 2. update config for cli <img width="1578" height="807" alt="image" src="https://github.com/user-attachments/assets/b444cd7e-e535-4f5d-b6ca-1781090dc79c" /> <img width="1593" height="823" alt="image" src="https://github.com/user-attachments/assets/eb664447-fdcd-4e31-9a2b-7cdf582f8bdf" /> cc: @MaryGao ### Packages impacted by this PR ### Issues associated with this PR ### Describe the problem that is addressed by this PR ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary) --------- Co-authored-by: Kyle Zhang <[email protected]>
117 lines
3.7 KiB
PowerShell
117 lines
3.7 KiB
PowerShell
#Requires -Version 7.0
|
|
<#
|
|
.SYNOPSIS
|
|
Updates the version for a specific Azure SDK package.
|
|
.DESCRIPTION
|
|
This script updates the package version by invoking the update-version
|
|
command from @azure-tools/js-sdk-release-tools.
|
|
|
|
The script validates the package path and runs the version update tool.
|
|
.PARAMETER SdkRepoPath
|
|
The absolute path to the root folder of the local SDK repository.
|
|
.PARAMETER PackagePath
|
|
The absolute path to the root folder of the local SDK project (package).
|
|
Must contain a valid package.json file.
|
|
.PARAMETER ReleaseType
|
|
The type of release: 'beta' or 'stable'.
|
|
.PARAMETER Version
|
|
The version number to set (e.g., '1.0.0' or '1.0.0-beta.1').
|
|
.PARAMETER ReleaseDate
|
|
The release date in YYYY-MM-DD format.
|
|
.EXAMPLE
|
|
.\update-version.ps1 `
|
|
-SdkRepoPath "D:\GithubSource\tmpSource\azure-sdk-for-js" `
|
|
-PackagePath "D:\GithubSource\tmpSource\azure-sdk-for-js\sdk\storage\arm-storage" `
|
|
-ReleaseType "stable" `
|
|
-Version "1.0.0" `
|
|
-ReleaseDate "2025-11-13"
|
|
|
|
Updates the version for the arm-storage package.
|
|
.NOTES
|
|
- Requires js-sdk-release-tools to be installed in eng/tools/js-sdk-release-tools.
|
|
- The tool will update package.json and CHANGELOG.md with the new version.
|
|
#>
|
|
[CmdletBinding()]
|
|
param (
|
|
[Parameter(Mandatory = $true, HelpMessage = "Absolute path to the SDK repository root")]
|
|
[string]$SdkRepoPath,
|
|
|
|
[Parameter(Mandatory = $true, HelpMessage = "Absolute path to the SDK package directory")]
|
|
[string]$PackagePath,
|
|
|
|
[Parameter(Mandatory = $false, HelpMessage = "Release type: 'beta' or 'stable'")]
|
|
[ValidateSet('beta', 'stable')]
|
|
[string]$ReleaseType,
|
|
|
|
[Parameter(Mandatory = $false, HelpMessage = "Version number (e.g., '1.0.0' or '1.0.0-beta.1')")]
|
|
[string]$Version,
|
|
|
|
[Parameter(Mandatory = $false, HelpMessage = "Release date in YYYY-MM-DD format")]
|
|
[string]$ReleaseDate
|
|
)
|
|
|
|
# Import common helpers
|
|
. (Join-Path $PSScriptRoot ".." "common" "scripts" "Helpers" "CommandInvocation-Helpers.ps1")
|
|
|
|
# Validate that at least one of ReleaseType or Version is provided
|
|
if (-not $ReleaseType -and -not $Version) {
|
|
Write-Host "Error: Either -ReleaseType or -Version must be provided" -ForegroundColor Red
|
|
exit 1
|
|
}
|
|
|
|
# Main execution
|
|
try {
|
|
# Validate SDK repository path
|
|
if (-not (Test-Path $SdkRepoPath)) {
|
|
throw "SDK repository path does not exist: $SdkRepoPath"
|
|
}
|
|
# Validate package path
|
|
if (-not (Test-Path $PackagePath)) {
|
|
throw "Package path does not exist: $PackagePath"
|
|
}
|
|
|
|
Push-Location $SdkRepoPath
|
|
|
|
# Install js-sdk-release-tools if needed
|
|
$releaseToolsPath = "eng\tools\js-sdk-release-tools"
|
|
if (-not (Test-Path $releaseToolsPath)) {
|
|
throw "Release tools path does not exist: $releaseToolsPath"
|
|
}
|
|
|
|
Write-Host "Installing js-sdk-release-tools dependencies..." -ForegroundColor Cyan
|
|
Invoke-LoggedCommand "npm --prefix $releaseToolsPath ci"
|
|
Write-Host ""
|
|
|
|
# Build the command arguments string
|
|
$cmdArgs = "--sdkRepoPath $SdkRepoPath --packagePath $PackagePath"
|
|
|
|
if ($ReleaseType) {
|
|
$cmdArgs += " --releaseType $ReleaseType"
|
|
}
|
|
|
|
if ($Version) {
|
|
$cmdArgs += " --version $Version"
|
|
}
|
|
|
|
if ($ReleaseDate) {
|
|
$cmdArgs += " --releaseDate $ReleaseDate"
|
|
}
|
|
|
|
# Run the update-version command using npm exec
|
|
Write-Host "Updating package version..." -ForegroundColor Cyan
|
|
Write-Host ""
|
|
$command = "npm --prefix $releaseToolsPath exec --no -- update-version -- $cmdArgs"
|
|
Invoke-LoggedCommand $command
|
|
|
|
Write-Host ""
|
|
Write-Host "Package version update completed successfully!" -ForegroundColor Green
|
|
}
|
|
catch {
|
|
Write-Host ""
|
|
Write-Host "Update version failed: $($_.Exception.Message)" -ForegroundColor Red
|
|
exit 1
|
|
}
|
|
finally {
|
|
Pop-Location
|
|
}
|