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
Explain why we run tests against dev versions #5244
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -112,6 +112,51 @@ the previous section: | |
| 1.0.1 | ✅ | The latest micro version of `1.0` | | ||
| 1.1.dev | ✅ | The version installed by `install_dev` | | ||
|
||
## Why do we run tests against development versions? | ||
|
||
In cross-version testing, we daily run tests against not only publicly available versions but also | ||
development versions installed from GitHub or nightly wheels. This section explains why. | ||
|
||
### Without dev version test | ||
|
||
First, let's take a look at what would happen **without** dev version test. | ||
|
||
``` | ||
| | ||
├─ XGBoost merges a change on the master branch that breaks MLflow's XGBoost integration. | ||
| | ||
├─ MLflow 1.20.0 release date | ||
| | ||
├─ XGBoost 1.5.0 release date | ||
├─ ❌ We notice the change here and might need to make a patch release if it's critical. | ||
| | ||
v | ||
time | ||
``` | ||
|
||
- We can't notice the change until XGBoost 1.5.0 is released. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "We didn't notice the change until after XGBoost 1.5.0 was released" |
||
- MLflow 1.20.0 doesn't work with XGBoost 1.5.0. | ||
|
||
### With dev version test | ||
|
||
Then, let's take a look at what would happen **with** dev version test. | ||
|
||
``` | ||
| | ||
├─ XGBoost merges a change on the master branch that breaks MLflow's XGBoost integration. | ||
├─ ✅ Tests for the XGBoost integration fail -> We can notice the change and apply a fix for it. | ||
| | ||
├─ MLflow 1.20.0 release date | ||
| | ||
├─ XGBoost 1.5.0 release date | ||
| | ||
v | ||
time | ||
``` | ||
|
||
- We can notice the change **before XGBoost 1.5.0 is released** and apply a fix for it **before releasing MLflow 1.20.0**. | ||
- MLflow 1.20.0 works with XGBoost 1.5.0. | ||
|
||
## When do we run cross version tests? | ||
|
||
1. Daily at 7:00 UTC using a cron scheduler. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"... we run daily tests against both publicly available and pre-release development versions for all dependent libraries that are used by MLflow. This section explains why."