Skip to content

Skip ApiCompat for SDK automation #37688

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

Merged
live1206 merged 1 commit into from
Jul 18, 2023
Merged

Skip ApiCompat for SDK automation #37688

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion eng/scripts/automation/GenerateAndBuildLib.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -753,7 +753,7 @@ function GeneratePackage()
} else {
# Build
Write-Host "Start to build sdk: $projectFolder"
dotnet build $projectFolder
dotnet build $projectFolder /p:RunApiCompat=$false
Copy link
Copy Markdown
Member

@weshaggard weshaggard Jul 18, 2023

Choose a reason for hiding this comment

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

Why did we disable this? Part of the point of running during SDK automation is to find API breaking changes.

Copy link
Copy Markdown
Member Author

@live1206 live1206 Jul 19, 2023

Choose a reason for hiding this comment

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

This ties to the work of making SDK automation required in swagger PR review.
Right now, .NET Track 2 SDK automation is failing mostly due to breaking changes.
We do not deal with the breaking changes until the SDK generation, so it seems no need to fail it during swagger PR review.
cc @ArthurMa1978

Copy link
Copy Markdown
Member

@ArthurMa1978 ArthurMa1978 Jul 19, 2023

Choose a reason for hiding this comment

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

Yes, we don't want to run the apicompat check at this job which blocks the swagger review process.
Next step is add an optional job for apicompat checking.

Copy link
Copy Markdown
Member

@weshaggard weshaggard Jul 19, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

How does it block the swagger review process? Even if the check is red that is a break and should be handled but it shouldn't bock the swagger review. We should just approve the break fix it. I think this is a bad idea to remove this completely. If there are some specific libraries that we want to disable this for then we should do it in the project instead of disabling for everyone.

I will also add that some of the other languages also do breaking change detection in the SDK automation.

FYI @raych1

if ( !$? ) {
Write-Error "Failed to build sdk. exit code: $?"
$result = "failed"
Expand Down