inner loop, update-changelogcontent tool, add script to integrate

[haolingdong-msft]

Fix Azure/azure-sdk-tools#12382

Description

As suggested by @weidongxu-microsoft, I'm referring to this code to write the script.

The logic could be different from the update change log logics in sdk automation, regarding to selecting which version to compare with.

This PR fetches the latest stable version to compare with, if not found, fetch the latest beta version. While sdk automation pipeline uses different version for different cases (I've also adviced @XiaofeiCao on the logics and add some comments into the current code to make it easier to understand, thanks @XiaofeiCao !):

• Breaking change detection: always comparing with latest stable version, which is useful in sdk validation pipeline.
• Changelog generations: comparing with latest stable version if current release type is preview, otherwise, comparing with latest preview version.

We could use the current logic for simplicity for V1 and have furthur discussion to consolidate logics for both inner loop and pipeline.

Code Change

1. Automation-Sdk-UpdateChangelog.ps1
2. eng/swagger_to_sdk_config.json to integrate with AzureSd.CLI

Test

integrate locally and can generate changelogs well:

All SDK Contribution checklist:

• The pull request does not introduce [breaking changes]
• CHANGELOG is updated for new features, bug fixes or other significant changes.
• I have read the contribution guidelines.

General Guidelines and Best Practices

• Title of the pull request is clear and informative.
• There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

• Pull request includes test coverage for the included changes.

[weidongxu-microsoft]

One question (may actually to EngSys), is about how best to unit test Powershell script.

Searched the net, but didn't find something apparent.

[haolingdong-msft]

One question (may actually to EngSys), is about how best to unit test Powershell script.

Searched the net, but didn't find something apparent.

Great question, I'm also searching this and I asked @msyyc the same question. Python is testing the script written by python, powershell is just a wrapper. @msyyc Please correct me if I understand wronly.
Add @raych1 for suggestion and guidance, thanks!

[raych1]

One question (may actually to EngSys), is about how best to unit test Powershell script.
Searched the net, but didn't find something apparent.

Great question, I'm also searching this and I asked @msyyc the same question. Python is testing the script written by python, powershell is just a wrapper. @msyyc Please correct me if I understand wronly. Add @raych1 for suggestion and guidance, thanks!

We already have the script test pipeline template in the eng/common folder. It uses the Pester test framework to test the powershell script. We can create test and pipeline for each language. This is an example test for .NET.

[haolingdong-msft]

Thanks @raych1 for the guidance! I will add unit test in a separate PR, is there any existing documents on how to add a unit test?

[Copilot]

Pull Request Overview

This PR introduces automation tooling to update CHANGELOG.md files by comparing built SDK packages with their latest released versions from Maven Central. The changes include a new PowerShell script for changelog generation, integration with the SDK's swagger-to-sdk configuration, and clarifying comments in the Python automation code.

• Adds Automation-Sdk-UpdateChangelog.ps1 script that downloads the latest released JAR, compares it with the current build, and updates CHANGELOG.md
• Integrates the script into swagger_to_sdk_config.json for use with AzureSdk.CLI tooling
• Adds clarifying comments to Python automation files explaining version comparison logic

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

File	Description
eng/swagger_to_sdk_config.json	Adds configuration for the updateChangelogContentScript pointing to the new PowerShell automation script
eng/scripts/Automation-Sdk-UpdateChangelog.ps1	New script that automates CHANGELOG.md updates by comparing JARs from Maven Central with local builds
eng/automation/utils.py	Adds comment explaining the get_latest_release_version function's behavior
eng/automation/generate.py	Adds explanatory comments about version handling and changelog generation logic; updates function call with additional parameter

[weidongxu-microsoft]

Overall LGTM

[raych1]

Thanks @raych1 for the guidance! I will add unit test in a separate PR, is there any existing documents on how to add a unit test?

@haolingdong-msft I haven't found any guidance on that. But it's pretty straight forward and you can check out the pester doc.

[weidongxu-microsoft]

LGTM for internal test and basis for iteration and future improvement.

Please do have the consensus with Wes on the few comments.

[weshaggard]

Thanks for updating to using the common changelog code. I added a couple comments around potentially promoting some of the code to common so it can be shared and can use the same logic and regex's etc.