breaking changes run in ci #16170

kristapratico · 2021-01-14T17:25:12Z

Python is the only language that doesn't have a check for API breaks in CI: https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/367/Capabilities-and-State. This is an effort to fix that.

Example run in Form Recognizer here: https://dev.azure.com/azure-sdk/public/_build/results?buildId=686253&view=logs&j=b70e5e73-bbb6-5567-0939-8415943fadb9&t=efe9ac6d-3fdb-50af-24e1-4319f36eecb4

This is an opt-in check for now which uses an allowlist. Long term plans will be to integrate this into the APIview tool itself.

…g at base class vars, lists->dicts in json reports

…d some docs

iscai-msft

ba

scbedd · 2021-01-14T20:42:23Z

eng/tox/tox.ini

+
+
+[testenv:breaking]
+skipsdist = false


Suggested change

skipsdist = false

skipsdist = true

scbedd · 2021-01-14T20:42:31Z

eng/tox/tox.ini

+
+[testenv:breaking]
+skipsdist = false
+skip_install = false


Suggested change

skip_install = false

skip_install = true

scbedd · 2021-01-14T20:43:21Z

eng/tox/tox.ini

+[testenv:breaking]
+skipsdist = false
+skip_install = false
+usedevelop = true


usedevelop in tox land tells it to install with -e. We don't want to install anything for this tox env, so probably set to false? Honestly it doesn't really matter given that the previous two comments shut off this being used anyway.

Thanks Scott! I'm laughing at how I was 0/3 on those config options 😆

My bad for not understanding these options, we definitely need to install the current package for this check to work.

https://dev.azure.com/azure-sdk/public/_build/results?buildId=688098&view=logs&j=b70e5e73-bbb6-5567-0939-8415943fadb9&t=efe9ac6d-3fdb-50af-24e1-4319f36eecb4

scbedd

Small nitpicks, on the tox.ini, but the CI pieces look solid!

* adding some work, very wip * running from tox now * refactored breaking changes checkers into class * major refactoring of checkers - no longer dividing client, now looking at base class vars, lists->dicts in json reports * another major refactor, added more checkers, moved to scripts dir * a few fixes, better names * changed function report, added new checks * update to ivars so i'm not passing so many parameters into check funcs * adding first tests, fixing bugs * adding check for ignore breaking changes, fixes a few bugs * added more tests, moved tracker to its own file, fixed ignore, started some docs * added checker for removed kwargs * fix table in readme * fixing naming * add more docs * fix readme formatting * rename model to generic class * bug fixes, redo tests * cleanup * try run in ci * intentionally create a breaking change in form * try removing extra steps * make sure passes with no breaking changes in ci * remove from breaking changes allowlist and make sure doesn't run * add form and text to allowlist * fix tox.ini config * revert options

Dev sql microsoft.sql 2021 05 01 preview release (Azure#16289) * add base for Microsoft.sql * Update Readme.md * update version in swagger example files * remove ss * update swagger files * update readme.md * add missing json files * update custom-words.txt to address the spelling check * remove 201 define in ServerUpdate.json * Sync sql 2021 05 01 with main branch (Azure#16236) * Update comment.yml for publish pr (Azure#16166) * Update comment.yml * Update comment.yml * Bump dependencies (Azure#16170) * bump avocado * bump mocha * remove submodule (Azure#16171) * add azure-resource-manager-schema to servicelinker (Azure#16176) Co-authored-by: Nan Jiang <naji@microsoft.com> * Update pr assignment config (Azure#16175) * [Synapse] - fix scheme for Artifacts and update readme to include KQL scripts for October release (Azure#16035) * [Synapse] - fix scheme for Notebook, Spark Job definition and SQL script * Update dataset, linked service and pipeline * Update release tag for october release * Correct type of result limit * Add arguments for SynapseSparkJobActivityTypeProperties Co-authored-by: Dongwei Wang <dongwwa@microsoft.com> * fix (Azure#16164) Merging the change to have accurate Swagger * Remove requirement of identity field in the request for TURN. (Azure#15966) * Remove requirement of identity field in the request. * Update PR * Address comment * change api version in readme for sdk release (Azure#16187) * Add blockchain to latest profile * Add additional types * api version change Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Ping Zhu <pizh@Pings-MacBook-Pro.local> * [Search] Rename types for better SDK code (Azure#16039) * Rename types for better SDK code * Rename Speller and Captions search options * Reorder parameters to have consistency across APIs * Remove 'SearchIndexer' prefix from projection selectors Remove 'global' prefix from default flags on custom entities * Change enum name AdlsGen2->AzureDataLakeStorageGen2 Change property name storageContainer->storageContainerName * move additional .NET SDK renames to the REST spec * Revert changes in KnowledgeStore which has GAed * Revert changes in CustomEntityLookupSkill which has GAed * Revert changes in SIKSBlobProjectionSelector which has GAed * Revert changes in SearchIndexerDataSourceType which has GAed * Rename ignoreResetRequirements->skipIndexerResetRequirementForCache * fix validStreamingUnits (Azure#16143) Co-authored-by: Roslyn Lu <roslu@microsoft.com> * Fix schemas readme files (Azure#16207) * Fix schemas readme files * fix ref * add resourcemanager in module-name (Azure#16206) * add resourcemanager in module-name * add go track2 repo in readme.md * fix * Minor description update for createorupdate & update slot (Azure#15457) * add scmMinTlsVersion * modify description for createorupdate & update slot for all API versions Co-authored-by: Edwin Diaz <eddiazme@microsoft.com> * [Hub Generated] Review request for Microsoft.Security to add version preview/2021-08-01-preview (Azure#16096) * Adds base for updating Microsoft.Security from version stable/2021-07-01 to version 2021-08-01-preview * Updates readme * Updates API version in new specs and examples * First pass at Microsoft.Security/standards for review/preview * Addressing Round-1 feedback, adding missing descriptions and changing scoping to match ProxyResource type * First pass for Microsoft.Security\standardComponents * Changes to fix a typo in an example spec * Added Microsoft.Security/standardAssignments * Fix naming convention issue * Removed types based on Hila's feedback * Changes to data model for both API calls * Fix example errors and typos * Add systemData to Microsoft.Security/standards * Changes to fix systemData linting * un-nest systemData fields in examples * More systemData placement * Naming convention name to assignments from standardAssignment * Additional example added * Changes to address descriptive comments on field types * Add systemData readOnly * prettier-fix against examples * Cleaned types to ref standard v2 common-types entry similar to securityForIoT * Re-added v2 folder? * Missed a change here? * Cleanup of v2 type completely, updated readme.md * Adds suppression to readme * Adds suppression to readme * Change modification to suppress operations linting Co-authored-by: Adam Holliday <adamho@microsoft.com> * Yifanzhou/api version change (Azure#16191) * remove Catalog * update 2021-05-01-preview * delete 2021-09-01 * Update readme.md * Update purviewcatalog.json * change read-only property (Azure#16209) Co-authored-by: Parv Saxena <pasaxena@microsoft.com> * Update account.json - make CollectionReferece type writable (Azure#16208) * Update account.json Updating the CollectionReference to be writeable to unblock the customers. * Update account.json Need the default set in the client SDK * Fixed an event name typo in its description. (Azure#16227) * Introduce new API version for Microsoft.ProviderHub 2021-09-01-preview (Azure#15723) * Introduce new API version for Microsoft.ProviderHub 2021-09-01-preview * Add PrivateResourceProviderConfigurations * Add PrivateRP examples * Fix enum type. * Fix enum again * Prettier * Fix prettier error * Add readme.md + prettier * Fix * Fix avocado error * Modify interface * Fix issue * Make it private preview * Remove private RP changes * Update SKU settings Co-authored-by: REDMOND\lakshv <lakshv@microsoft.com> Co-authored-by: He Huang <47040595+hjhhh3000vitae@users.noreply.github.com> * fluidrelay_readme_config (Azure#16192) fluidrelay_readme_config * Add community gallery proxy resource (Azure#16043) * [Hub Generated] Public private branch 'dev-storagecache-Microsoft.StorageCache-2021-09-01' (Azure#16152) * Adds base for updating Microsoft.StorageCache from version stable/2021-05-01 to version 2021-09-01 * Updates readme * Updates API version in new specs and examples * 2021-09-01 API * Fix LintDiff Co-authored-by: rebecca337 <80353400+rebecca337@users.noreply.github.com> Co-authored-by: Rebecca Dupuis <rdupuis@microsoft.com> * Fix S360 bugs for swagger FSPG 2020-02-14-preview, 2021-06-01-preview and 2021-06-01 APIs (Azure#15946) * Changed FSPG RestartParameter.failoverMode from string to enum for API 2021-06-01, 2021-06-01-preview, and 2021-06-15-privatepreview * Change enum first letter to lower case * Change to upper case * Fix S360 bugs for swagger FSPG 2020-02-14-preview, 2021-06-01-preview and 2021-06-01 APIs * Add email reminder when PR makes changes in Synapse (Azure#16116) * add email reminder to synapse * fix for comment * ServiceBus add batch tag (Azure#16229) * add code owner to synapse (Azure#16230) * [Datafactory] Power Query model changes for multiple queries (Azure#16158) * [Synapse] Add release tag for management SDK Oct. release (Azure#16213) * update release tag * fix for avocado Co-authored-by: Tianen <347142915@qq.com> Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> Co-authored-by: najian <jiangnan8924@gmail.com> Co-authored-by: Nan Jiang <naji@microsoft.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Dongwei Wang <bean0idear@163.com> Co-authored-by: Dongwei Wang <dongwwa@microsoft.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: AriZavala2 <77034370+AriZavala2@users.noreply.github.com> Co-authored-by: PingZhu2232 <36140352+PingZhu2232@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Ping Zhu <pizh@Pings-MacBook-Pro.local> Co-authored-by: Mohit Chakraborty <8271806+Mohit-Chakraborty@users.noreply.github.com> Co-authored-by: Roslyn Lu <roslyn.lu@gmail.com> Co-authored-by: Roslyn Lu <roslu@microsoft.com> Co-authored-by: JiahuiPeng <46921893+804873052@users.noreply.github.com> Co-authored-by: edwin-msft <71858592+edwin-msft@users.noreply.github.com> Co-authored-by: Edwin Diaz <eddiazme@microsoft.com> Co-authored-by: dochollidayxx <dochollidayxx@gmail.com> Co-authored-by: Adam Holliday <adamho@microsoft.com> Co-authored-by: yifan-zhou922 <78060542+yifan-zhou922@users.noreply.github.com> Co-authored-by: Parv Saxena <psaxena6@jhu.edu> Co-authored-by: Parv Saxena <pasaxena@microsoft.com> Co-authored-by: hvermis <hvermis@microsoft.com> Co-authored-by: xuepingd <75347475+xuepingd@users.noreply.github.com> Co-authored-by: laxmankumar12 <vlk_laxman@yahoo.com> Co-authored-by: REDMOND\lakshv <lakshv@microsoft.com> Co-authored-by: He Huang <47040595+hjhhh3000vitae@users.noreply.github.com> Co-authored-by: Zed Lei <59104634+RAY-316@users.noreply.github.com> Co-authored-by: kangsun-ctrl <69279251+kangsun-ctrl@users.noreply.github.com> Co-authored-by: brpanask <64860651+brpanask@users.noreply.github.com> Co-authored-by: rebecca337 <80353400+rebecca337@users.noreply.github.com> Co-authored-by: Rebecca Dupuis <rdupuis@microsoft.com> Co-authored-by: xunsun-commits <84804232+xunsun-commits@users.noreply.github.com> Co-authored-by: Wan Yang <wanyang@microsoft.com> Co-authored-by: soma-ms <84877933+soma-ms@users.noreply.github.com> * remove blank line * address comments * address the description comment * update the swagger * remove ManagedInstances_ListOutboundNetworkDependenciesByManagedInstance * Update from microsoft.sql 2021-05-01-preview to base branch (Azure#16184) * Update comment.yml for publish pr (Azure#16166) * Update comment.yml * Update comment.yml * Bump dependencies (Azure#16170) * bump avocado * bump mocha * remove submodule (Azure#16171) * add azure-resource-manager-schema to servicelinker (Azure#16176) Co-authored-by: Nan Jiang <naji@microsoft.com> * Update pr assignment config (Azure#16175) * [Synapse] - fix scheme for Artifacts and update readme to include KQL scripts for October release (Azure#16035) * [Synapse] - fix scheme for Notebook, Spark Job definition and SQL script * Update dataset, linked service and pipeline * Update release tag for october release * Correct type of result limit * Add arguments for SynapseSparkJobActivityTypeProperties Co-authored-by: Dongwei Wang <dongwwa@microsoft.com> * fix (Azure#16164) Merging the change to have accurate Swagger * update swagger files * update readme.md * add missing json files * update custom-words.txt to address the spelling check * remove 201 define in ServerUpdate.json * remove blank line * address comments * address the description comment * update the swagger * remove ManagedInstances_ListOutboundNetworkDependenciesByManagedInstance Co-authored-by: Tianen <347142915@qq.com> Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> Co-authored-by: najian <jiangnan8924@gmail.com> Co-authored-by: Nan Jiang <naji@microsoft.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Dongwei Wang <bean0idear@163.com> Co-authored-by: Dongwei Wang <dongwwa@microsoft.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: Tianen <347142915@qq.com> Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> Co-authored-by: najian <jiangnan8924@gmail.com> Co-authored-by: Nan Jiang <naji@microsoft.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Dongwei Wang <bean0idear@163.com> Co-authored-by: Dongwei Wang <dongwwa@microsoft.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: AriZavala2 <77034370+AriZavala2@users.noreply.github.com> Co-authored-by: PingZhu2232 <36140352+PingZhu2232@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Ping Zhu <pizh@Pings-MacBook-Pro.local> Co-authored-by: Mohit Chakraborty <8271806+Mohit-Chakraborty@users.noreply.github.com> Co-authored-by: Roslyn Lu <roslyn.lu@gmail.com> Co-authored-by: Roslyn Lu <roslu@microsoft.com> Co-authored-by: JiahuiPeng <46921893+804873052@users.noreply.github.com> Co-authored-by: edwin-msft <71858592+edwin-msft@users.noreply.github.com> Co-authored-by: Edwin Diaz <eddiazme@microsoft.com> Co-authored-by: dochollidayxx <dochollidayxx@gmail.com> Co-authored-by: Adam Holliday <adamho@microsoft.com> Co-authored-by: yifan-zhou922 <78060542+yifan-zhou922@users.noreply.github.com> Co-authored-by: Parv Saxena <psaxena6@jhu.edu> Co-authored-by: Parv Saxena <pasaxena@microsoft.com> Co-authored-by: hvermis <hvermis@microsoft.com> Co-authored-by: xuepingd <75347475+xuepingd@users.noreply.github.com> Co-authored-by: laxmankumar12 <vlk_laxman@yahoo.com> Co-authored-by: REDMOND\lakshv <lakshv@microsoft.com> Co-authored-by: He Huang <47040595+hjhhh3000vitae@users.noreply.github.com> Co-authored-by: Zed Lei <59104634+RAY-316@users.noreply.github.com> Co-authored-by: kangsun-ctrl <69279251+kangsun-ctrl@users.noreply.github.com> Co-authored-by: brpanask <64860651+brpanask@users.noreply.github.com> Co-authored-by: rebecca337 <80353400+rebecca337@users.noreply.github.com> Co-authored-by: Rebecca Dupuis <rdupuis@microsoft.com> Co-authored-by: xunsun-commits <84804232+xunsun-commits@users.noreply.github.com> Co-authored-by: Wan Yang <wanyang@microsoft.com> Co-authored-by: soma-ms <84877933+soma-ms@users.noreply.github.com>

kristapratico added 27 commits December 3, 2020 15:14

adding some work, very wip

5286730

running from tox now

32ba488

refactored breaking changes checkers into class

ef0b148

major refactoring of checkers - no longer dividing client, now lookin…

cb163ea

…g at base class vars, lists->dicts in json reports

another major refactor, added more checkers, moved to scripts dir

4949d43

a few fixes, better names

cf6a594

changed function report, added new checks

da54701

update to ivars so i'm not passing so many parameters into check funcs

9afa5ab

adding first tests, fixing bugs

727299f

adding check for ignore breaking changes, fixes a few bugs

17ecb43

added more tests, moved tracker to its own file, fixed ignore, starte…

78cc659

…d some docs

added checker for removed kwargs

b91ead0

fix table in readme

7c093e7

fixing naming

d9684bf

add more docs

5f01400

fix readme formatting

654bf25

rename model to generic class

a0cf5a0

bug fixes, redo tests

07bb521

merge master

21a2415

cleanup

7a7ec52

Merge branch 'master' into detect-breaking-changes

7f51081

try run in ci

8189eb8

intentionally create a breaking change in form

6ba453d

try removing extra steps

143a2a7

make sure passes with no breaking changes in ci

cb0825b

remove from breaking changes allowlist and make sure doesn't run

4ad6b45

add form and text to allowlist

690640a

kristapratico self-assigned this Jan 14, 2021

kristapratico requested review from danieljurek and mitchdenny as code owners January 14, 2021 17:25

kristapratico requested review from scbedd and weshaggard as code owners January 14, 2021 17:25

kristapratico requested review from iscai-msft and removed request for mitchdenny, danieljurek and weshaggard January 14, 2021 17:25

iscai-msft approved these changes Jan 14, 2021

View reviewed changes

scbedd reviewed Jan 14, 2021

View reviewed changes

eng/tox/tox.ini

[testenv:breaking]

skipsdist = false

Copy link

Member

scbedd Jan 14, 2021

Choose a reason for hiding this comment

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

Suggested change

skipsdist = false

skipsdist = true

scbedd reviewed Jan 14, 2021

View reviewed changes

eng/tox/tox.ini

[testenv:breaking]

skipsdist = false

skip_install = false

Copy link

Member

scbedd Jan 14, 2021

Choose a reason for hiding this comment

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

Suggested change

skip_install = false

skip_install = true

scbedd reviewed Jan 14, 2021

View reviewed changes

scbedd approved these changes Jan 14, 2021

View reviewed changes

kristapratico added 2 commits January 14, 2021 15:36

fix tox.ini config

df338f5

revert options

5189785

kristapratico merged commit 07c6a28 into master Jan 15, 2021

kristapratico deleted the breaking-changes-tool branch January 15, 2021 16:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

breaking changes run in ci #16170

breaking changes run in ci #16170

kristapratico commented Jan 14, 2021 •

edited

Loading

iscai-msft left a comment

scbedd Jan 14, 2021

scbedd Jan 14, 2021

scbedd Jan 14, 2021 •

edited

Loading

kristapratico Jan 14, 2021

kristapratico Jan 15, 2021

scbedd left a comment

breaking changes run in ci #16170

breaking changes run in ci #16170

Conversation

kristapratico commented Jan 14, 2021 • edited Loading

iscai-msft left a comment

Choose a reason for hiding this comment

scbedd Jan 14, 2021

Choose a reason for hiding this comment

scbedd Jan 14, 2021

Choose a reason for hiding this comment

scbedd Jan 14, 2021 • edited Loading

Choose a reason for hiding this comment

kristapratico Jan 14, 2021

Choose a reason for hiding this comment

kristapratico Jan 15, 2021

Choose a reason for hiding this comment

scbedd left a comment

Choose a reason for hiding this comment

kristapratico commented Jan 14, 2021 •

edited

Loading

scbedd Jan 14, 2021 •

edited

Loading