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.

Sign up for GitHub

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

Jump to bottom

Check binary compatibility #282

Merged
merged 1 commit into from
Apr 1, 2022
Merged

Check binary compatibility #282

merged 1 commit into from
Apr 1, 2022

Conversation

remcowesterhoud
Copy link
Contributor

@remcowesterhoud remcowesterhoud commented Mar 31, 2022 •
edited
Loading

Description

The revapi maven plugin allows us to perform API checks during our maven build. It will check the current build against the latest released version available on maven.

This tool ensures our interfaces are backwards compatibility. Since we only guarantee backwards compatibility on some of our modules it has only been added to these modules.

⚠️ We really should not check our compatibility against pre-releases. I cannot make this change part of this as it will break stuff if we do this before the 8.0.0 release. For this I have created a separate issue: #283

Related issues

closes #275

Definition of Done

Not all items need to be done depending on the issue and the pull request.

Code changes:

  • The changes are backwards compatibility with previous versions
  • If it fixes a bug then PRs are created to backport the fix

Testing:

  • There are unit/integration tests that verify all acceptance criterias of the issue
  • New tests are written to ensure backwards compatibility with further versions
  • The behavior is tested manually

Documentation:

  • Javadoc has been written
  • The documentation is updated

@remcowesterhoud remcowesterhoud mentioned this pull request Mar 31, 2022
Closed
@github-actions
Copy link

github-actions bot commented Mar 31, 2022 •
edited
Loading

Unit Test Results

136 files  136 suites   7m 55s ⏱️
240 tests 240 ✔️ 0 💤 0 ❌
916 runs  916 ✔️ 0 💤 0 ❌

Results for commit 2847b86.

♻️ This comment has been updated with latest results.

@remcowesterhoud remcowesterhoud force-pushed the 275_binary_compatibility branch from 545d0a7 to d08da4d Compare April 1, 2022 12:25
korthout
korthout approved these changes Apr 1, 2022
View reviewed changes
Copy link
Member

@korthout korthout left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice and clean, I like it! LGTM 🍰

@remcowesterhoud
feat: add revapi
2847b86 
The revapi maven plugin allows us to perform API checks during our maven build. It will check the current build against the latest released version available on maven.

This tool ensures our interfaces are backwards compatibility. Since we only guarantee backwards compatibility on some of our modules it has only been added to these modules.
@remcowesterhoud remcowesterhoud force-pushed the 275_binary_compatibility branch from d08da4d to 2847b86 Compare April 1, 2022 13:30
@remcowesterhoud remcowesterhoud merged commit 75454d1 into main Apr 1, 2022
@remcowesterhoud remcowesterhoud deleted the 275_binary_compatibility branch April 1, 2022 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@korthout korthout korthout approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Check binary compatibility
2 participants
@remcowesterhoud @korthout