Skip to content

Commit

Permalink
Proposal for versioning the ilab config file
Browse files Browse the repository at this point in the history
Related to instructlab/instructlab/issues/1725

Signed-off-by: Ali Maredia <amaredia@redhat.com>
  • Loading branch information
alimaredia committed Jul 17, 2024
1 parent 8fde6f7 commit cb68ac3
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/schema/ilab-config-version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# `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 match the release of `ilab`.

## 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:

- Tooling to support forward compatability of configuration files
- Limits for the forward and backward compatability of configuration files

0 comments on commit cb68ac3

Please sign in to comment.