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

Action parameters and config options represent integers in two different ways (int vs integer) in charmcraft.yaml #2067

Open
gruyaume opened this issue Jan 7, 2025 · 0 comments
Labels
Enhancement New feature or request

Comments

@gruyaume
Copy link

gruyaume commented Jan 7, 2025

What needs to get done

Description

Action parameters and config options represent integers in two different ways in charmcraft.yaml. Configuration option accept the type int, while action parameters accept the type integer. We're talking about the same concept here, there is no good reason to have two ways of talking about integers.

Reference

...
config:
  options:
    subscriber-count:
      type: int
      default: 1
      description: Number of subscribers to simulate

actions:
  my-action:
    description: Run my action
    params:
      timeout:
        type: integer
        description: Time to wait for the simulation to complete (in seconds). The more subscribers, the longer the simulation will take.
        default: 300

Why it needs to get done

The same concept is represented in two different ways, unnecessarily confusing users.

@gruyaume gruyaume added the Enhancement New feature or request label Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant