partiql / partiql-lang-kotlin

PartiQL libraries and tools in Kotlin.
https://partiql.org/
Apache License 2.0
538 stars 60 forks source link

Add binary API compatibility checks to gradle check #1410

Closed alancai98 closed 6 months ago

alancai98 commented 6 months ago

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:

Other Information

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[bot] commented 6 months ago

Conformance comparison report

Base (db1c85b0fcfccdf6e9c8069e45d48525cc81e947) 4bf3080dfa22b1872e67e93439a13e887e42712f +/-
% Passing 92.54% 92.54% 0.00%
:white_check_mark: Passing 5384 5384 0
:x: Failing 434 434 0
:large_orange_diamond: Ignored 0 0 0
Total Tests 5818 5818 0

Number passing in both: 5384

Number failing in both: 434

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

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

codecov-commenter commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ 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](https://app.codecov.io/gh/partiql/partiql-lang-kotlin/pull/1410/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=partiql) | Coverage Δ | | |---|---|---| | [CLI](https://app.codecov.io/gh/partiql/partiql-lang-kotlin/pull/1410/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=partiql) | `11.82% <ø> (ø)` | | | [EXAMPLES](https://app.codecov.io/gh/partiql/partiql-lang-kotlin/pull/1410/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=partiql) | `80.07% <ø> (ø)` | | | [LANG](https://app.codecov.io/gh/partiql/partiql-lang-kotlin/pull/1410/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=partiql) | `81.04% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=partiql#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

alancai98 commented 6 months ago

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.