-
Notifications
You must be signed in to change notification settings - Fork 40
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
The big refactor — step 1: prep work #192
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1. Running binary-compatibility-validator on code 2. Flagging public data classes and failing build 3. Running Poko to autogen equals/hashcode/toString
rock3r
force-pushed
the
the-big-refactor-prep
branch
from
October 19, 2023 18:11
d797738
to
6780ae0
Compare
devkanro
reviewed
Oct 20, 2023
And how about add a CI pipeline to make sure contributors updated the api files? |
@devkanro if you forget to update the API signatures, the ci will fail |
devkanro
approved these changes
Oct 20, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the first step of "the big refactor".
In this step:
equals
/hashcode
/toString
but not methods likecopy
andcomponentN
which easily break binary compatibility. This fixes Remove usage of data classes #83 (see issue for more details).api
files, that track the current state of the public API (they can be skipped when reviewing). A newapiCheck
is added to thecheck
task that ensures no changes break binary compatibility by mistake.validatePublicApi
task to published modules that breaks thecheck
task whenever a data class is detected in the public APIImportant
After this PR is merged, whenever adding new APIs, you need to run the
apiDump
method to update the.api
files. If API changes are detected that are not in the.api
files, the CI will fail.