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

Add check for version compatibility by building a small sample. #1026

Merged
merged 2 commits into from
Nov 29, 2022

Conversation

jcamiel
Copy link
Collaborator

@jcamiel jcamiel commented Nov 25, 2022

@fabricereix @lepapareil

This PR add a new check in the CI.

We build a small sample that can be build with the last released hurl crate. In the CI, we check that this sample can be build using the SNAPSHOT version of hurl crates, without any changes. If this check is not passing, it means that we have broken the API compatibility and must increment hurl crate's major version.

The sample uses most of hurl crate's public structures to detect API changes.

If we detect a major version change in the snapshot version, we bypass this check.

For instance, following #1030 and the additions of two new options, we have to increment major version. We'll use some code pattern soon to allow new options creations without breaking major compatibility.

(see #972)

@jcamiel jcamiel force-pushed the feature/add-check-for-binary-compatibility branch 4 times, most recently from 18bad93 to 9540996 Compare November 27, 2022 18:45
@jcamiel jcamiel marked this pull request as ready for review November 27, 2022 18:51
@jcamiel jcamiel marked this pull request as draft November 28, 2022 10:00
@jcamiel jcamiel force-pushed the feature/add-check-for-binary-compatibility branch 4 times, most recently from c63569a to 8a551ff Compare November 29, 2022 12:03
@jcamiel jcamiel changed the title Add check for binary compatibility by building a small sample. Add check for version compatibility by building a small sample. Nov 29, 2022
@jcamiel jcamiel marked this pull request as ready for review November 29, 2022 12:25
@jcamiel jcamiel force-pushed the feature/add-check-for-binary-compatibility branch from 74cb29d to b89716b Compare November 29, 2022 12:51
@jcamiel jcamiel force-pushed the feature/add-check-for-binary-compatibility branch from b89716b to 589c4c2 Compare November 29, 2022 14:51
Copy link
Collaborator

@lepapareil lepapareil left a comment

Choose a reason for hiding this comment

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

All good for compatibility.sh 👌

@jcamiel jcamiel assigned fabricereix and unassigned lepapareil Nov 29, 2022
@fabricereix
Copy link
Collaborator

/accept

@hurl-bot
Copy link
Collaborator

🕗 /accept is running, please wait for completion.

@hurl-bot
Copy link
Collaborator

✅ Pull request accepted and closed by fabricereix with fast forward merge..

# List of commits merged from Orange-OpenSource/hurl/feature/add-check-for-binary-compatibility branch into Orange-OpenSource/hurl/master branch:

  • 589c4c2 Update 1.9.0-SNAPSHOT to 2.0.0 due to major breaking change.
  • 06bf7e6 Add check for binary compatibility by building a small sample.

@github-actions github-actions bot merged commit 589c4c2 into master Nov 29, 2022
@hurl-bot hurl-bot deleted the feature/add-check-for-binary-compatibility branch November 29, 2022 15:24
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.

4 participants