Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Kestra flow schema #3979

Merged
merged 4 commits into from
Aug 14, 2024
Merged

add Kestra flow schema #3979

merged 4 commits into from
Aug 14, 2024

Conversation

benpops89
Copy link
Contributor

Adds schema for Kestra flows.

Kestra is an orchestration framework similar to Airflow that defines it's pipelines (flows) in YAML. This schma provides auto-complete and validation of YAML.

When validating the schema I did get the following error Error: strict more: unknown keyword: "markdownDescription". It might be something specific to Kestra but not sure how it should be handled.

Solves #3978

Copy link
Contributor

github-actions bot commented Aug 9, 2024

Thanks for the PR!

This section of the codebase is owned by @madskristensen and @hyperupcall - if they write a comment saying "LGTM" then it will be merged.

@hyperupcall
Copy link
Member

hyperupcall commented Aug 9, 2024

Hey, thanks for this PR

When validating the schema I did get the following error Error: strict more: unknown keyword: "markdownDescription". > It might be something specific to Kestra but not sure how it should be handled.

Schemas are validated with Ajv, which has a "strict mode" that we enable to catch common issues. More information is in the documentation, but you can edit src/schema-validation.jsonc, and add your unknown key name to the "options[$schemaName].unknownKeywords" field. If you would like to disable strict mode checks all together, you can edit the "ajvNotStrictMode" top-level field.

@benpops89
Copy link
Contributor Author

@hyperupcall - thanks for pointing me in the right direction. I have added a list of unknownKeywords for Kestra to that file and the checks are passing.

@hyperupcall
Copy link
Member

hyperupcall commented Aug 13, 2024

@benpops89 Thanks - there appears to be one more failure in CI - spellcheck. The list of ignored words can be changed in .pre-commit-config.yaml if you need to update that;

@benpops89
Copy link
Contributor Author

@hyperupcall - thanks for your support on this. I have run codespell locally and fixed all the typos in the file and added one word CopyIn to the list of ignored words and the tests are now passing 🚀

@hyperupcall
Copy link
Member

Awesome, thank you!

@hyperupcall hyperupcall merged commit 6d4407c into SchemaStore:master Aug 14, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants