Create a validation check for configuration file.

[harshad16]

Is your feature request related to a problem? Please describe.
aicoe-ci should have a validation check on the configuration file, as mistakenly users can define the keys wrong in the configuration file, which may lead to erroneous development.

Describe the solution you'd like
YAML file validation is to be present in the pipeline, to check the .aicoe-ci.yaml file.

Describe alternatives you've considered
Leave it to the user to maintain the correct configuration file.

Additional context
operate-first/support#17

[tumido]

@harshad16 I was thinking about this overnight and I think this task can be extended a bit to cover much more if you'd be interested:

Instead of a bare check we can choose to generate a proper schema for .aicoe-ci.yaml

You can then choose to upload it to https://www.schemastore.org/ so it can be consumed by IDE linters yaml language server (for example in VS Code

To facilitate this CI check, the schema can be consumed by a pre-commit hook to do the validation. This can solve both local pre-commit runs as well as there's no need to create a special case pipeline in CI, the pre commit CI job would cover it.

Some resources:
pre-commit/pre-commit-hooks#71
adrienverge/yamllint#37
https://github.com/Grokzen/pykwalify
redhat-developer/yaml-language-server#106

[goern]

/kind feature
/priority important-longterm

[harshad16]

thanks, @tumido for the suggestion, seems like a good approach. I will go over the resources your shared 👍
I was just thinking of a having check in the pipeline, so that if the user doesn't correct the configuration file, then the pipeline can prompt with an issue, that following key would cause issue while using the pipeline.

[anushkrishnav]

Can I join and work on this ?

[harshad16]

Can I join and work on this ?

surely, welcome @anushkrishnav
we could definitely use more tekton pipelines knowledge.
have a look at the documentation and get started docs for the beginning
this requires some knowledge of openshift, tekton-pipeline/openshift-pipelines, and for this issue pre-commit
there are some easier issues, I will label them with good-first-issue if you would like to get started with that.

[anushkrishnav]

I would love to start with easier issues and go one to advanced ones

[sesheta]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[harshad16]

/remove-lifecycle stale

[sesheta]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[sesheta]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle rotten

[harshad16]

/lifecycle frozen