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 OL compatibility table #2493

Merged
merged 8 commits into from
May 31, 2023
Merged

Add OL compatibility table #2493

merged 8 commits into from
May 31, 2023

Conversation

wslulciuc
Copy link
Member

@wslulciuc wslulciuc commented May 26, 2023

Problem

Closes: #2483

Solution

This PR adds a compatibility table to better communicate which version of Marquez supports a given version of OpenLineage.

Screen Shot 2023-05-30 at 12 05 13 PM

Checklist

  • You've signed-off your work
  • Your changes are accompanied by tests (if relevant)
  • Your change contains a small diff and is self-contained
  • You've updated any relevant documentation (if relevant)
  • You've included a one-line summary of your change for the CHANGELOG.md (Depending on the change, this may not be necessary).
  • You've versioned your .sql database schema migration according to Flyway's naming convention (if relevant)
  • You've included a header in any source code files (if relevant)

@codecov
Copy link

codecov bot commented May 26, 2023

Codecov Report

Merging #2493 (a436ed9) into main (94b11f4) will not change coverage.
The diff coverage is n/a.

❗ Current head a436ed9 differs from pull request most recent head d13fb15. Consider uploading reports for the commit d13fb15 to get more accurate results

@@            Coverage Diff            @@
##               main    #2493   +/-   ##
=========================================
  Coverage     83.78%   83.78%           
  Complexity     1233     1233           
=========================================
  Files           235      235           
  Lines          5626     5626           
  Branches        270      270           
=========================================
  Hits           4714     4714           
  Misses          768      768           
  Partials        144      144           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@julienledem
Copy link
Member

This looks good to me.
This PR should probably also update the release process to indicate to update this table and how a release goes from recommended to maintenance.

@wslulciuc
Copy link
Member Author

Thanks for the suggestion, @julienledem. I've added more details on categories of compatibility and releasing guidelines.

@wslulciuc wslulciuc requested a review from merobi-hub May 30, 2023 05:06
@merobi-hub
Copy link
Collaborator

Thanks, @wslulciuc , this LGTM, but I'm guessing "unrelease" in this sentence should be "unreleased": The unrelease version of Marquez is marked CURRENT and does not come with any guarantees, but is assumed to remain compatible with OpenLineage, although surprises happen and there maybe rare exceptions.

Copy link
Collaborator

@merobi-hub merobi-hub left a comment

Choose a reason for hiding this comment

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

Please see comment.

@jtandrew
Copy link

@wslulciuc I think this looks great, it shows the details of which version matches to which version.

Signed-off-by: wslulciuc <[email protected]>
Signed-off-by: wslulciuc <[email protected]>
@wslulciuc wslulciuc requested a review from merobi-hub May 30, 2023 19:04
Copy link
Collaborator

@merobi-hub merobi-hub left a comment

Choose a reason for hiding this comment

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

LG!

@wslulciuc wslulciuc enabled auto-merge (squash) May 31, 2023 07:30
@wslulciuc wslulciuc merged commit 4fa6501 into main May 31, 2023
2 checks passed
@wslulciuc wslulciuc deleted the feature/mqz-ol-compatibility branch May 31, 2023 07:38
Xavier-Cliquennois pushed a commit to Xavier-Cliquennois/marquez that referenced this pull request Jul 26, 2023
* Add OL compatibility table

Signed-off-by: wslulciuc <[email protected]>

* Add info on OL compatibility

Signed-off-by: wslulciuc <[email protected]>

* continued: Add info on OL compatibility

Signed-off-by: wslulciuc <[email protected]>

* Update `RELEASING.md` with compatibility guidelines

Signed-off-by: wslulciuc <[email protected]>

* continued: Add info on OL compatibility

Signed-off-by: wslulciuc <[email protected]>

* Pin to OL 1-0-5

Signed-off-by: wslulciuc <[email protected]>

* Fix typo

Signed-off-by: wslulciuc <[email protected]>

---------

Signed-off-by: wslulciuc <[email protected]>
Signed-off-by: Xavier-Cliquennois <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add compatibility table with OpenLineage
5 participants