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

Add document detailing release strategy for libraries #125

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nathan-weinberg
Copy link
Member

Resolves #124

Copy link
Contributor

@dhellmann dhellmann left a 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:

  1. 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.
  2. 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.
  3. 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.
  4. 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.

docs/library-release-strategy.md Outdated Show resolved Hide resolved
Copy link
Member

@markstur markstur left a comment

Choose a reason for hiding this comment

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

see comments

docs/library-release-strategy.md Outdated Show resolved Hide resolved
docs/library-release-strategy.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Draft document detailing release procedures for new libraries
4 participants