-
Notifications
You must be signed in to change notification settings - Fork 29
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 document detailing release strategy for libraries #125
base: main
Are you sure you want to change the base?
Add document detailing release strategy for libraries #125
Conversation
f9c035e
to
fd761bd
Compare
fd761bd
to
877afe9
Compare
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 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
.0
release 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.
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.
see comments
877afe9
to
e7c17ac
Compare
e7c17ac
to
e547780
Compare
e547780
to
1bd1e70
Compare
Signed-off-by: Nathan Weinberg <[email protected]>
1bd1e70
to
18a2ae6
Compare
Resolves #124