-
Notifications
You must be signed in to change notification settings - Fork 441
Description
Since instructlab/taxonomy#616, the taxonomy side has included schema files for validating the Taxonomy YAML. The CLI should also validate with the schema.
given that we are cloning the taxonomy already, we could just use the schema file from there.
one question is how to do a schema update (like #702, instructlab/taxonomy#635) on both side.
CLI side will want to develop the feature first before taxonomy side officially supports that.
@lehors suggested maybe the taxonomy side could take a dev/main branch or a similar main/stable tag idea so they would be able to have an schema in development.
From @anik120 in #760 (comment):
We need to think about the implications of needing the taxonomy folder cloned into the current working directory. At the moment, if you make any changes to the cli that pulls in this dependency, the test cases will break. It's also not a great design to need the taxonomy folder in the current working directory. The path of least resistance here if we have a central repository, say instruct-lab/api
that contains this yaml schema, which is then pulled into both the taxonomy
repository and the cli
repository to implement changes needed for the tooling.
Breakdown of work:
- Create repository for the JSON schema for Taxonomy (Add schema schema#1)
- Add schema checking to CLI (Use the taxonomy schema to validate taxonomy yaml files #776)
- Update Taxonomy repository to use the new schema repository (schema: Use schema repository via submodule taxonomy#721)
- Update CLI repository to use the new schema repository (Use schema repository via submodule #913)
- Add additional unit tests
- Refactor redundant code (schema: Remove code no longer needed since we schema validate yaml #841)
- Update documentation