Skip to content

Proposal: Use dashes (instead of underscores) in input names #57

Description

@smockle

From @gr2m in #54 (comment):

I think we should use dashes for our arguments, it seems to be the convention for actions/* actions, e.g. see https://github.com/actions/checkout/

Notably, changing the input names affects the translated environment variable names1:

  • An input named my_var is translated to INPUTS_MY_VAR.
  • An input named my-var is translated to INPUTS_MY-VAR.

So, we may want a plan for backwards-compatibility, or we may want to ship this in a major version bump.

Footnotes

  1. cf. “Metadata syntax for GitHub Actions > Example: Specifying inputs”

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions