Naming convention for inputs and outputs

[nitrocode]

context

It would be nice to have consistent action inputs so this is more predictable.

Perhaps the default opinion can be kebab case and be configurable?

options

kebab case

inputs:
  my-input-to-action:

Official github actions seem to use kebab case

• https://github.com/actions/upload-artifact/blob/main/action.yml
• https://github.com/actions/checkout/blob/main/action.yml
  • notable that it uses token as an input instead of GITHUB_TOKEN or even github-token

snake case

inputs:
  my_input_to_action:

• https://github.com/LouisBrunner/checks-action

camel case

inputs:
  filePath:

• https://github.com/thollander/actions-comment-pull-request

upperkebab

inputs:
  MY-INPUT-TO-ACTION:

I haven't found an example of this

uppersnake

inputs:
  GITHUB_TOKEN:

• https://github.com/lhotari/action-upterm/blob/main/action.yml

mixed (basically no standard)

inputs:
  my-inPut_to_ACTION:

I haven't found an example of this in the wild, however, internally, you may want to use kebab case and pass that input to an upstream action that uses camel case so you may be left with an input like comment-filePath. We wrap multiple upstream actions in private actions which is why comment would need to be prefixed to differentiate the input from other upstream actions used.

references

• https://github.com/orgs/community/discussions/39547
• Consistent input naming convention thollander/actions-comment-pull-request#386

[rhysd]

Since there is no official style guide and actionlint doesn't enforce code styles, I feel that enforcing specific style on inputs/outputs is out of scope of actionlint.

However, it would be nice idea to use consistent naming convention not to confuse people on action's and reusable workflow's inputs/outputs usage 👍. I'll consider to add a check for names are consistent.