Skip to content
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

Integrate binary validator #92

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

Conversation

KCeh
Copy link
Collaborator

@KCeh KCeh commented Dec 31, 2024

Summary

I have integrated Binary compatibility validator into Sentinel 🎉
This tool will be used to pay closer attention to public API changes (since Sentinel is library!)

Changes

  • Integrated Binary compatibility validator
  • Initial API dump

Type

  • Feature: This pull request introduces a new feature.
  • Bug fix: This pull request fixes a bug.
  • Refactor: This pull request refactors existing code.
  • Documentation: This pull request updates documentation.
  • Other: This pull request makes other changes.

Additional information

  • This pull request introduces a breaking change.

Description

With this PR we will have the option to use binary compatibility validator for public API changes.
The tool is configured only to generate API for libs (not sample app!). Gradle task for API dump is apiDump
We can use Gradle task apiCheck to check changes in public API.

Why is this important?
Because Sentinel is library. And if we changed API that consumer use then consumers will encounter breaking changes.
This is also helpful to know when to bump major version in major.minor.patch versioning system.

Checklist

  • I have performed a self-review of my own code.
  • I have tested my changes, including edge cases.
  • I have added necessary tests for the changes introduced (if applicable).
  • I have updated the documentation to reflect my changes (if applicable).

Additional notes

@KCeh KCeh added the enhancement New feature or request label Dec 31, 2024
@KCeh KCeh requested a review from AsimRibo December 31, 2024 15:20
@KCeh KCeh self-assigned this Dec 31, 2024
@KCeh KCeh changed the title Iintegrate binary validator Integrate binary validator Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant