Add release instruction #58
Merged
Conversation
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
|
Job PR-58-5d95bba is done. |
gradientsky
reviewed
Mar 22, 2023
docs/ReleaseInstructions.md
Outdated
|
|
||
| * Check all dependency version ranges. | ||
| * Ensure all dependencies are not capped by major version, unless the reason is documented inline. | ||
| * Example of major version cap: `scikit-learn<2` |
There was a problem hiding this comment.
In quick reading this looks like an example how to do it. Maybe emphasize avoiding this? Examples usually read as instructions. (also see other places where examples are non-prescriptive).
* Ensure all dependencies are not capped by major version, unless the reason is documented inline.
* ❎ Avoid - major version cap: `scikit-learn<2`There was a problem hiding this comment.
Good suggestion! Though we might want to do the same to our release instruction in our main repo, as this is just copied from there :)
docs/ReleaseInstructions.md
Outdated
| * Example: `scikit-learn==1.1.3`. This is very fragile and overly strict. | ||
| * Ensure all dependencies are capped by minor version and not micro version unless the reason is documented inline. | ||
| * Minor version capping would be `<x.y`. Micro version capping would be `<x.y.z`. | ||
| * Avoid capping to `<x.y.0`, instead do the cleaner identical cap: `<x.y`. |
There was a problem hiding this comment.
Maybe split:
* ❎ Avoid: capping to `<x.y.0`
* ✅ Do: `<x.y`.
gradientsky
reviewed
Mar 22, 2023
docs/ReleaseInstructions.md
Outdated
Comment on lines
16
to
17
| * Example: `scikit-learn<1.2` is not reasonable because it is almost certain that `scikit-learn==0.0.1` is not supported. | ||
| * A better range: `scikit-learn>=1.0,<1.2` |
There was a problem hiding this comment.
* ❎ Avoid: `scikit-learn<1.2` is not reasonable because it is almost certain that `scikit-learn==0.0.1` is not supported.
* ✅ A better range: `scikit-learn>=1.0,<1.2`
gradientsky
approved these changes
Mar 22, 2023
|
Job PR-58-02e228a is done. |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.