Skip to content

Enable explicit API mode and add Binary Compatibility Validator #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

MGaetan89
Copy link
Member

Description

This PR enforces some good practices for Kotlin libraries. The complete guide is available on Kotlin's website.

Changes made

  • Enable Explicit API mode. This forces us to declare the visibility of every member, as well as the type of public members.
  • Add Binary Compatibility Validator. This generates a dump of the library's public API and complains when it changes.
  • Update the GitHub Workflow to check API dumps and update them if needed.
  • Fix explicit mode errors.

@MGaetan89 MGaetan89 self-assigned this May 7, 2025
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Pillarbox May 7, 2025
@MGaetan89 MGaetan89 moved this from 📋 Backlog to 🚧 In Progress in Pillarbox May 7, 2025
Copy link

github-actions bot commented May 7, 2025

Code Coverage

Overall Project 39.17% 🟢
File Coverage
MediaRouteButtonViewModel.kt 90.91% 🟢
MediaRouteButton.kt 82.22% 🟢
MediaRouteControllerDialog.kt 0% 🟢
MediaRouteChooserDialog.kt 0% 🟢

@MGaetan89 MGaetan89 marked this pull request as ready for review May 7, 2025 15:23
@MGaetan89 MGaetan89 moved this from 🚧 In Progress to 🍿 Code Review in Pillarbox May 7, 2025
@MGaetan89 MGaetan89 force-pushed the improve_library_setup branch from 6e19fd8 to b82fe50 Compare May 8, 2025 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🍿 Code Review
Development

Successfully merging this pull request may close these issues.

1 participant