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

More helpful error messages for common schema errors, e.g. singular input, parameter, argument, output #12899

Open
agilgur5 opened this issue Apr 5, 2024 · 0 comments
Labels
area/templating Templating with `{{...}}` type/feature Feature request

Comments

@agilgur5
Copy link
Member

agilgur5 commented Apr 5, 2024

Summary

It would be nice if Argo could catch some common schema errors, such as accidentally using input instead of inputs.
Particularly for templating it can be hard to tell what went wrong

Follow-up to this Slack thread where a user had:

when: "{{= input.parameters.SYNC_ONLY != 'true' }}"

and was getting errors that didn't really help narrow down the problem -- similar to #10630:

message: 'Invalid ''when'' expression ''{{= input.parameters.SYNC_ONLY != ''true''}}'': Invalid token: ''{{='' (hint: try wrapping the affected expression in quotes ("))'

This could be considered a subissue of #10630 to be specifically more helpful for these common typos (and perhaps other common typos).
This type of detection could also be useful outside of templating -- for invalid YAML manifests for instance that accidentally use input instead of inputs.

Use Cases

It could help quite greatly when debugging mistakes in Workflows, and would reduce support burden as well, given how common these can be.

  1. For templating with expressions
  2. For writing Workflow manifest YAML itself

Message from the maintainers:

Love this feature request? Give it a 👍. We prioritise the proposals with the most 👍.

@agilgur5 agilgur5 added type/feature Feature request area/templating Templating with `{{...}}` labels Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/templating Templating with `{{...}}` type/feature Feature request
Projects
None yet
Development

No branches or pull requests

1 participant