Add binary API compatibility checks to gradle check

[alancai98]

Description

PR shows the current set of public APIs in all of our published libraries. I used https://github.com/Kotlin/binary-compatibility-validator gradle plugin which maintains a list of public binary APIs (as a .api file committed to our project). By default, the gradle task will run the apiCheck task. If there's a change to the public API (adding, modifying, deleting anything public), the apiCheck task will fail. To fix the failure, we can run apiDump to update the .api file(s) and commit the changes.

TODO:

• determine if this should target the main or v1 branch
• (separate PRs) looking into all of the current public APIs

Other Information

• Updated Unreleased Section in CHANGELOG: [NO]

  • No changes to public APIs.

• Any backward-incompatible changes? [NO]

• Any new external dependencies? [YES]

  • Yes, using https://github.com/Kotlin/binary-compatibility-validator. I looked at an alternative binary API comparison tool https://github.com/siom79/japicmp. This tool has some more configurability but doesn't have a good way to maintain a list of public APIs. We can reevaluate if/when we have a need for japicmp's features.

• Do your changes comply with the Contributing Guidelines
  and Code Style Guidelines? [YES]

License Information

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[github-actions]

Conformance comparison report

	Base (db1c85b)	4bf3080	+/-
% Passing	92.54%	92.54%	0.00%
✅ Passing	5384	5384	0
❌ Failing	434	434	0
🔶 Ignored	0	0	0
Total Tests	5818	5818	0

Number passing in both: 5384

Number failing in both: 434

Number passing in Base (db1c85b) but now fail: 0

Number failing in Base (db1c85b) but now pass: 0

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.14%. Comparing base (db1c85b) to head (b31ba4d).

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #1410   +/-   ##
=========================================
  Coverage     73.14%   73.14%           
  Complexity     2393     2393           
=========================================
  Files           247      247           
  Lines         17623    17623           
  Branches       3176     3176           
=========================================
  Hits          12890    12890           
  Misses         3856     3856           
  Partials        877      877           

Flag	Coverage Δ
CLI	11.82% <ø> (ø)
EXAMPLES	80.07% <ø> (ø)
LANG	81.04% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[alancai98]

Closing this PR currently targeting main. I will create a new PR adding the Kotlin binary API compatibility checks in the v1 branch after the merge from main to v1 is completed #1409.