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

Don't run revapi against pre releases #329

Merged
merged 2 commits into from
Apr 26, 2022
Merged

Conversation

remcowesterhoud
Copy link
Contributor

@remcowesterhoud remcowesterhoud commented Apr 20, 2022

Description

This PR adds a version format to the revapi configuration. This is a regex that will make sure we only check backwards compatibility against patch, minor and major releases.

I've also checked in the proto.lock file. This file is used to check the backwards compatibility of our grpc api.

Related issues

closes #283

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

The proto.lock file is used for checking backwards compatibility of our API
With pre-releases I mean alpha, snapshots and release candidates. When we release features in these releases we do not guarantee backwards compatibility.
@remcowesterhoud remcowesterhoud requested a review from pihme April 20, 2022 08:46
@github-actions
Copy link

Unit Test Results

  32 files    32 suites   1m 14s ⏱️
  98 tests   98 ✔️ 0 💤 0
307 runs  307 ✔️ 0 💤 0

Results for commit e791ac3.

@remcowesterhoud remcowesterhoud merged commit 314775f into main Apr 26, 2022
@remcowesterhoud remcowesterhoud deleted the 283_revapi_prereleases branch April 26, 2022 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Don't check binary compatibility against pre-releases
2 participants