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

Make spec.paused and spec.quiet a boolean in an upcoming version of the CRD #455

Open
LCaparelli opened this issue Aug 28, 2024 · 1 comment
Labels
breaking change Breaking change can impact some existing workflows. enhancement New feature or request

Comments

@LCaparelli
Copy link

Feature Description

Unless there are plans to support other values and make it sort of an enum (which is also a breaking change), it probably makes more sense for spec.paused to be a bool. AFAICT from the code, we only use it as such anyway.

The current implementation leads to some awkwardness when using it, for example:

  • in Helm charts, as part of a template, for which we need to add quotes around user input
  • in Crossplane compositions, where we want to receive a bool from the user and then need to convert it to a string in order to match the current interface
  • probably any abstraction built on top of this that offers the field as a bool to users

Suggested Solution (optional)

No response

Already existing or connected issues / PRs (optional)

No response

@yorugac
Copy link
Collaborator

yorugac commented Sep 5, 2024

Thanks for the issue, @LCaparelli! Such a change makes sense, AFAIS 👍

Btw, if we're going to break things here, we should also change spec.quiet type as well.

@yorugac yorugac added the breaking change Breaking change can impact some existing workflows. label Sep 5, 2024
@yorugac yorugac changed the title Make spec.paused a boolean in an upcoming version of the CRD Make spec.paused and spec.quiet a boolean in an upcoming version of the CRD Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Breaking change can impact some existing workflows. enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants