Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

sdk automation, fix changelog for mpg self-serve #44523

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

sdk automation, fix changelog for mpg self-serve #44523

wants to merge 2 commits into from

Conversation

XiaofeiCao
Copy link
Contributor

@XiaofeiCao XiaofeiCao commented Mar 6, 2025 •
edited
Loading

Description

For self-serve/automation, log would be:

2025-03-07 15:08:05 [INFO] [Changelog] Start breaking change detection for SDK automation.
2025-03-07 15:08:05 [INFO] [Changelog][Skip] no previous version
2025-03-07 15:08:05 [INFO] [Changelog] Complete breaking change detection for SDK automation.
2025-03-07 15:08:05 [INFO] [Changelog] Start generating changelog.
2025-03-07 15:08:05 [INFO] [Changelog] Compare stable version 1.0.0-beta.1 with current version 1.0.0-beta.2
2025-03-07 15:08:07 [INFO] [CHANGELOG] changelog jar: /var/folders/_7/x1pjmqgx7jbb2zc1hqvjn9nw0000gn/T/tmpwxnf7cru.jar -> /Users/xiaofeicao/projects/azure-sdk-for-java/sdk/impactreporting/azure-resourcemanager-impactreporting/target/azure-resourcemanager-impactreporting-1.0.0-beta.2.jar
2025-03-07 15:08:10 [INFO] [CHANGELOG] changelog output: b'{"changelog":"### Breaking Changes\n\n#### models.ImpactCategoryProperties was modified\n\n* description() was removed\n\n### Features Added\n\n#### models.ImpactCategoryProperties was modified\n\n* descriptions() was added\n\n","breakingChanges":["Method description() was removed in class com.azure.resourcemanager.impactreporting.models.ImpactCategoryProperties."]}\n'
2025-03-07 15:08:10 [INFO] [Changelog][Success] Write to changelog
2025-03-07 15:08:10 [INFO] [CHANGELOG][Version] Update changelog latest version
2025-03-07 15:08:10 [INFO] [Changelog][Success] Updated changelog latest version
2025-03-07 15:08:10 [INFO] [Changelog] Complete generating changelog.

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.

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
weidongxu-microsoft reviewed Mar 7, 2025
View reviewed changes
eng/automation/generate_utils.py Outdated
@@ -221,7 +221,7 @@ def compare_with_maven_package(
if not os.path.exists(new_jar):
raise Exception("Cannot found built jar in {0}".format(new_jar))
breaking, changelog, breaking_changes = generate_changelog_and_breaking_change(sdk_root, old_jar, new_jar)
if changelog is not None:
if changelog is not None and write_changelog:
Copy link
Member

@weidongxu-microsoft weidongxu-microsoft Mar 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can always write_changelog? (is the False for automation from specs repo?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the False for automation from specs repo?

Yes.
Seems update_changelog will overwrite everything for the first version. Indeed we can always write changelog.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@XiaofeiCao XiaofeiCao marked this pull request as ready for review March 7, 2025 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weidongxu-microsoft weidongxu-microsoft weidongxu-microsoft left review comments

@haolingdong-msft haolingdong-msft Awaiting requested review from haolingdong-msft haolingdong-msft is a code owner

@ArthurMa1978 ArthurMa1978 Awaiting requested review from ArthurMa1978 ArthurMa1978 is a code owner

@hallipr hallipr Awaiting requested review from hallipr hallipr is a code owner

@weshaggard weshaggard Awaiting requested review from weshaggard weshaggard is a code owner

@benbp benbp Awaiting requested review from benbp benbp is a code owner

@JimSuplizio JimSuplizio Awaiting requested review from JimSuplizio JimSuplizio is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@XiaofeiCao @weidongxu-microsoft