-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
Proposal for versioning the ilab config file
Related to instructlab/instructlab/issues/1725 Signed-off-by: Ali Maredia <[email protected]>
1 parent
8fde6f7
commit 1c87bc1
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# `ilab` Config.yaml Versioning | ||
|
||
## Problem Statement | ||
|
||
Currently the `ilab` CLI's configuration file, `config.yaml`, does not contain a version. | ||
|
||
The config file in `ilab` version `0.17` cannot be used in future versions of `ilab` due to new mandatory fields and changes to existing fields. | ||
|
||
As the configuration file grows, changes, and becomes more complex, versioning is necessary in order to support forwards and backwards compatibility. | ||
|
||
## Proposal | ||
|
||
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`. | ||
|
||
To ensure configuration files before the `0.18.0` release of `ilab` cannot be used, if `version` is not included as a field in the configuration file, `ilab` will throw an error. | ||
|
||
## Future Considerations | ||
|
||
As future development of `ilab` occurs, ramifications and tooling for the versioning the configuration file will need to be determined for users and developers. | ||
|
||
Such considerations include but are not limited to: | ||
|
||
- Rules for incrementing the version number | ||
- Tooling to support forward compatibility of configuration files | ||
- Limits for the forward and backward compatibility of configuration files |