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

ci: breaking change policy #2324

Merged
merged 7 commits into from May 13, 2024
Merged

Conversation

wjones127
Copy link
Contributor

No description provided.

@github-actions github-actions bot added the ci Github Action or Test issues label May 10, 2024
@wjones127
Copy link
Contributor Author

Tested in wjones127#3

@wjones127 wjones127 marked this pull request as ready for review May 10, 2024 21:07
@wjones127 wjones127 requested a review from westonpace May 10, 2024 21:07
conventional commit markers: either exclamation mark after the type
(such as `feat!: change signature of func`) or have `BREAKING CHANGE` in the
body of the PR. A CI job will add a `breaking-change` label to the PR, which is
what will ultimately be used to CI to determine if the minor version should be
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
what will ultimately be used to CI to determine if the minor version should be
what will ultimately be used by CI to determine if the minor version should be

Comment on lines +83 to +85
* Upgrading a dependency pin that is in the Rust API. In particular, upgrading
`DataFusion` and `Arrow` are breaking changes. Changing dependencies that are
not exposed in our public API are not considered breaking changes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Technically this is only true if we are upgrading from one major version to another. However, given that has been the case for most releases of arrow and datafusion, I'm not sure it needs to be called out.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Depends on our definition of breaking change. For example if we change the pin from 40.0.0 to 40.0.1, and a user has pinned =40.0.0, we will have broken their build. But not really made a meaningful break change behavior wise I think.

@@ -0,0 +1,63 @@
"""
Copy link
Contributor

Choose a reason for hiding this comment

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

This is cool!

@wjones127 wjones127 merged commit c6f82fe into lancedb:main May 13, 2024
2 checks passed
eddyxu pushed a commit that referenced this pull request May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Github Action or Test issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants