CLOUDP-261727: Breaking changes engine improvements (#432)

Co-authored-by: Wojciech Trocki <[email protected]>

Author: lantoli

.github/workflows/autoupdate-prod.yaml

@@ -23,6 +23,8 @@ jobs:
           git config --global user.name "github-actions[bot]"
           git add .
           git commit --allow-empty -m "fix: update OpenAPI spec"
+      - name: Set old commit for SDK API diff
+        run: echo "API_DIFF_OLD_COMMIT=$(git rev-parse HEAD)" >> $GITHUB_ENV
       - name: Run generation
         working-directory: ./tools
         run: |
@@ -41,13 +43,13 @@ jobs:
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         run: |
           git add . && git commit -m "fix: Generated SDK source code and docs"
+      - name: Set new commit for SDK API diff
+        if: steps.verify-changed-files.outputs.files_changed == 'true'
+        run: echo "API_DIFF_NEW_COMMIT=$(git rev-parse HEAD)" >> $GITHUB_ENV
       - name: Release updates
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         working-directory: ./tools
-        env:
-          GIT_BASE_REF: ${{ github.sha }}
-        run: |
-          make new-release  
+        run: make new-release  
       - name: Ensure all markdown code is formatted
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         working-directory: ./tools

tools/CONTRIBUTING.md

@@ -45,3 +45,8 @@ This enables us to verify new templates changes.
 Templates are sourced from openapi generator:
 
 https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/go
+
+## Go API Diff
+
+We use [go-apidiff](https://github.com/joelanford/go-apidiff) to detect if there are breaking changes and a new major version release is needed.
+In [Generate SDK Github action](../.github/workflows/autoupdate-prod.yaml), `API_DIFF_OLD_COMMIT` and `API_DIFF_NEW_COMMIT` are used to do the comparison.

tools/releaser/scripts/breaking-changes.sh

@@ -3,24 +3,21 @@ set -eu
 GOPATH=$(go env GOPATH)
 
 # Inputs:
-# GIT_BASE_REF - The base REF of the git repository (git rev-parse origin/main)
-# Usually "${{ github.event.pull_request.base.sha || github.event.merge_group.base_sha }}" 
+# API_DIFF_OLD_COMMIT: commit before the API changes to compare with. If not provided, script will fail with "unbound variable" error
+# API_DIFF_NEW_COMMIT: commit with the new API changes. If not provided, script will fail with "unbound variable" error
 # TARGET_BREAKING_CHANGES_FILE - file to save breaking changes
+TARGET_BREAKING_CHANGES_FILE=${TARGET_BREAKING_CHANGES_FILE:-""}
 script_path=$(dirname "$0")
 
 echo "Installing go-apidiff"
 go install github.com/joelanford/go-apidiff@latest > /dev/null
 
-current_ref=$(git rev-parse main || echo)
-GIT_BASE_REF=${GIT_BASE_REF:-$current_ref}
-TARGET_BREAKING_CHANGES_FILE=${TARGET_BREAKING_CHANGES_FILE:-""}
-
-echo "Running breaking changes check for $GIT_BASE_REF"
+echo "Running breaking changes check comparing commits ${API_DIFF_OLD_COMMIT} and ${API_DIFF_NEW_COMMIT}"
 
 pushd "$script_path/../../../" || exit ## workaround for --repo-path="../" not working
 echo "Changed directory to $(pwd)"
 set +e
-BREAKING_CHANGES=$("$GOPATH/bin/go-apidiff" "$GIT_BASE_REF" "$(git rev-parse head)" --compare-imports="false" --print-compatible="false" )
+BREAKING_CHANGES=$("$GOPATH/bin/go-apidiff" "${API_DIFF_OLD_COMMIT}" "${API_DIFF_NEW_COMMIT}" --compare-imports="false" --print-compatible="false")
 set -e
 popd || exit