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

Proposal for versioning the ilab config file #117

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

Conversation

alimaredia
Copy link
Contributor

@bjhargrave
Copy link
Contributor

bjhargrave commented Jul 17, 2024

Versioning implies there is a schema for each version to support some compatibility across versions. Otherwise the version value is just an opaque identity that the cli either understands or does not.

@alimaredia alimaredia force-pushed the ilab-config-version branch 4 times, most recently from 1c87bc1 to 287d2d4 Compare July 18, 2024 09:02

The `ilab` configuration file has a new `version` field at the top level of the config.

The value of `version` should start at `1.0`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The value of `version` should start at `1.0`.
The value of `version` should start at `1`.

I would just use a simple integer unless you plan to handle semantic versioning. Like where the cli handles all 1.x variants but not 2.x.

Copy link
Member

@hickeyma hickeyma left a comment

Choose a reason for hiding this comment

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

Thanks for pushing the proposal @alimaredia.

Open question about versioning configuration. Should configuration be tied to a major release rather than versioning it? In other words, the configuration needs to be backwards compatible within a major release version but breaking changes can apply on the next major version.

In that case, we can change configuration that breaks backwards compatibility up until InstructLab 1.0.0 release.

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.

3 participants