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

Improve the error reporting #169

Merged
merged 1 commit into from
Jul 18, 2023
Merged

Improve the error reporting #169

merged 1 commit into from
Jul 18, 2023

Conversation

julienrf
Copy link
Collaborator

versionCheck checks that the declared version number (e.g. 1.2.3) conforms to the declared compatibility guarantees (e.g. Compatibility.BinaryAndSourceCompatible).

Previously, when versionCheck failed, it only reported that the declared version was invalid. Now, it shows both the declared version and the compatibility intention. It also mentions the possibility to restrict the compatibility guarantees to fix the failure.

Fixes #126

versionCheck checks that the declared version number (e.g. 1.2.3) conforms to the declared compatibility guarantees (e.g. Compatibility.BinaryAndSourceCompatible).

Previously, when versionCheck failed, it only reported that the declared version was invalid. Now, it shows both the declared version and the compatibility intention. It also mentions the possibility to restrict the compatibility guarantees to fix the failure.
@julienrf julienrf merged commit 8b81e8a into main Jul 18, 2023
2 checks passed
@julienrf julienrf deleted the reporting branch July 18, 2023 17:17
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.

Usability issue: versionCheck doesn't show the problems it found
2 participants