CLOUDP-195429: detect breaking changes in the SDK (#172)

Author: wtrocki

.github/workflows/autoupdate-preview.yaml

@@ -58,6 +58,10 @@ jobs:
             2. Documentation style
             3. Transformation engine linting
 
+            ## Breaking Changes
+            
+            For list of possible breaking changes please refer to `Detect Breaking Changes` job.
+
             ## Release schedule
             
             PR is updated 3 times a week with latest changes from the RC for the API.

.github/workflows/autoupdate-prod.yaml

@@ -63,9 +63,10 @@ jobs:
             ## Manual Review Procedure
 
             1. Review changes in the OpenAPI file (openapi/atlas-api.yaml)
-            2. If we see any breaking changes without new resource version 
+            2. If we see any breaking changes without new resource version (
+              - Review breaking changes listed in `Detect Breaking Changes` action
               - Checkout PR locally and run `make update-version`
-              - Provide breaking changes infomation in generated ``./releaser/breaking_changes/{release_version}.md` file
+              - Provide breaking changes infomation in generated `./releaser/breaking_changes/{release_version}.md` file
               - Push your changes directly to the automation PR. 
             3. If we have major version release request feedback from additional reviewer if possible.
             4. Merge PR into main branch 

.github/workflows/breaking-changes.yaml

@@ -0,0 +1,14 @@
+name: (Optional) Detect Breaking Changes
+on: [ pull_request ]
+jobs:
+  go-apidiff:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: Install Go
+      uses: actions/setup-go@v4
+      with:
+        go-version-file: 'go.mod'
+    - uses: joelanford/go-apidiff@main