From e5872f9466cd2560164ad350866b6dbe7bc72323 Mon Sep 17 00:00:00 2001 From: Ali Maredia Date: Wed, 17 Jul 2024 09:32:48 -0400 Subject: [PATCH] Proposal for versioning the ilab config file Related to instructlab/instructlab/issues/1725 Signed-off-by: Ali Maredia --- docs/schema/ilab-config-version.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/schema/ilab-config-version.md diff --git a/docs/schema/ilab-config-version.md b/docs/schema/ilab-config-version.md new file mode 100644 index 0000000..d00b8a6 --- /dev/null +++ b/docs/schema/ilab-config-version.md @@ -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 compatibility of configuration files +- Limits for the forward and backward compatibility of configuration files