This repository was archived by the owner on Sep 9, 2025. It is now read-only.
Add document detailing release strategy for libraries#125
Merged
nathan-weinberg merged 1 commit intoinstructlab:maininstructlab/dev-docs:mainfrom Oct 18, 2024
nathan-weinberg:lib-release-stratnathan-weinberg/dev-docs:lib-release-stratCopy head branch name to clipboard
Merged
Add document detailing release strategy for libraries#125nathan-weinberg merged 1 commit intoinstructlab:maininstructlab/dev-docs:mainfrom nathan-weinberg:lib-release-stratnathan-weinberg/dev-docs:lib-release-stratCopy head branch name to clipboard
nathan-weinberg merged 1 commit intoinstructlab:maininstructlab/dev-docs:mainfrom
nathan-weinberg:lib-release-stratnathan-weinberg/dev-docs:lib-release-stratCopy head branch name to clipboard
Conversation
f9c035e to
fd761bd
Compare
fd761bd to
877afe9
Compare
dhellmann
reviewed
Aug 1, 2024
Contributor
dhellmann
left a comment
There was a problem hiding this comment.
We spent a lot of time describing release "models" for related projects in the OpenStack community. The document describing those models might be interesting reading for folks thinking about the same topic for InstructLab.
A few things to consider that aren't mentioned here:
- It's harder than it seems to make the version numbers of the CLI and libraries line up exactly and makes things more confusing to users and rebuilders. I recommend not even trying.
- Versioning schemes like SemVer can help signal when a new release has breaking changes, but it's still better to make releases backwards compatible as much as possible to ensure adoption of new releases.
- It makes it easier to reason about release series if the release branch is created from a tagged commit. That can be a
.0release or a release candidate release. - For libraries, no one can easily consume release candidates because they aren't installed automatically, so over-using them will make things harder, not easier.
877afe9 to
e7c17ac
Compare
e7c17ac to
e547780
Compare
1bd1e70 to
18a2ae6
Compare
RobotSail
reviewed
Oct 18, 2024
RobotSail
approved these changes
Oct 18, 2024
Member
RobotSail
left a comment
There was a problem hiding this comment.
This is all very reasonable and will help out with broader communication across different groups. LGTM.
4a6710f to
4b6e2ba
Compare
Signed-off-by: Nathan Weinberg <nweinber@redhat.com>
4b6e2ba to
b75924b
Compare
danmcp
approved these changes
Oct 18, 2024
Member
Author
|
I am going to merge this given the two approvals and amount of time it has sat in the queue, if anyone wants to iterate on these policies feel free to open up a followup PR for discussion |
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
6 participants
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.
Resolves #124