[sdk generation pipeline] Fix changelog duplication when re-generating management plane SDK #45156
+122
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When re-generating an SDK, the changelog generation pipeline inserts a new section at the top of CHANGELOG.md. The version update step then updates the first version line, but the previous section with the same version remains, creating duplicate content. This fix detects if the next version section after the updated one has the same version number. If so, it removes that duplicate section entirely, keeping only the newly generated one. Fixes: Azure/azure-sdk-tools#12425
msyyc
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses a changelog-generation edge case in the management-plane SDK regeneration workflow where updating the top version header can leave a duplicated version section behind.
Changes:
- Add logic in
sdk_update_version.pyto detect and remove a duplicate “next” version section after updating the first version header. - Add tests intended to validate duplicate-section removal and ensure non-duplicate sections remain.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
eng/tools/azure-sdk-tools/packaging_tools/sdk_update_version.py |
Updates changelog version header and attempts to delete an immediately-following duplicate version section. |
eng/tools/azure-sdk-tools/tests/test_sdk_update_version.py |
Adds test cases for duplicate-version section removal behavior. |
eng/tools/azure-sdk-tools/packaging_tools/sdk_update_version.py
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <[email protected]>
ChenxiJiang333
approved these changes
Feb 12, 2026
Member
Author
|
/check-enforcer override |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix
When re-generating a management plane SDK, the changelog generation pipeline inserts a new section at the top of CHANGELOG.md with a placeholder version. The version update step then replaces the first version line with the actual version, but the previous section with the same version number remains, creating duplicate content.
Fixes: Azure/azure-sdk-tools#12425