Azure / Azure/azure-sdk-tools

Update-ChangeLog.ps1 moved entry of a beta version to unexpected location below a lower version

Open
#16,225 0 comments 0 reactions 0 assignees View on GitHub
Central-EngSys
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
144

Description

repro steps

1. clone the azure-sdk-for-js repo (`gh repo clone Azure/azure-sdk-for-js` or similar)
2. `git checkout 1d09a0f4435fb32a35c141ae47694a158d91c789`
3. under pwsh, run

`./eng/common/scripts/Update-ChangeLog.ps1 -Version 12.32.1 -ServiceDirectory storage -PackageName @azure/storage-file-share -Unreleased $True -ReplaceLatestEntryTitle $false -ChangelogPath:sdk/storage/storage-file-share/CHANGELOG.md`

**Actual difference**, note that section for `## 12.32.0-beta.1 (2026-04-29)` has been moved to below `## 12.31.0 (2026-05-22)`

```diff
diff --git a/sdk/storage/storage-file-share/CHANGELOG.md b/sdk/storage/storage-file-share/CHANGELOG.md
index 52001a8fbae..cc2f7f5a080 100644
--- a/sdk/storage/storage-file-share/CHANGELOG.md
+++ b/sdk/storage/storage-file-share/CHANGELOG.md
@@ -1,17 +1,20 @@
# Release History

-## 12.32.0 (2026-06-24)
+## 12.32.1 (Unreleased)

### Features Added

-- Includes all features released in 12.32.0-beta.1.
+### Breaking Changes

-## 12.32.0-beta.1 (2026-04-29)
+### Bugs Fixed
+
+### Other Changes
+
+## 12.32.0 (2026-06-24)

### Features Added

-- Added support for service version 2026-06-06.
-- Added support for uploading up to 4 MiB of data with shareFileClient.create().
+- Includes all features released in 12.32.0-beta.1.

## 12.31.0 (2026-05-22)

@@ -19,6 +22,13 @@

- Includes all features released in 12.31.0-beta.1.

+## 12.32.0-beta.1 (2026-04-29)
+
+### Features Added
+
+- Added support for service version 2026-06-06.
+- Added support for uploading up to 4 MiB of data with shareFileClient.create().
+
## 12.31.0-beta.1 (2026-03-05)

### Features Added
```

Contributor guide

Open the contributing guide

Research direction

Start with eng/common/scripts/Update-ChangeLog.ps1 and the provided command, using sdk/storage/storage-file-share/CHANGELOG.md as the reproduction input. Inspect how beta and stable version sections are ordered, then rerun the reproduction to verify that 12.32.0-beta.1 remains above 12.31.0 after the update.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
release, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
70/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.