Skip to content

Commit cb68ac3

Browse files
committed
Proposal for versioning the ilab config file
Related to instructlab/instructlab/issues/1725 Signed-off-by: Ali Maredia <amaredia@redhat.com>
1 parent 8fde6f7 commit cb68ac3

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/schema/ilab-config-version.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# `ilab` Config.yaml Versioning
2+
3+
## Problem Statement
4+
5+
Currently the `ilab` CLI's configuration file, `config.yaml`, does not contain a version.
6+
7+
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.
8+
9+
As the configuration file grows, changes, and becomes more complex, versioning is necessary in order to support forwards and backwards compatibility.
10+
11+
## Proposal
12+
13+
The `ilab` configuration file has a new `version` field at the top level of the config.
14+
15+
The value of `version` should match the release of `ilab`.
16+
17+
## Future Considerations
18+
19+
As future development of `ilab` occurs, ramifications and tooling for the versioning the configuration file will need to be determined for users and developers.
20+
21+
Such considerations include but are not limited to:
22+
23+
- Tooling to support forward compatability of configuration files
24+
- Limits for the forward and backward compatability of configuration files

0 commit comments

Comments
 (0)