actions / create-github-app-token

GitHub Action for creating a GitHub App Installation Access Token
https://github.com/marketplace/actions/create-github-app-token
MIT License
344 stars 47 forks source link

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

Closed smockle closed 11 months ago

smockle commented 11 months ago

From @gr2m in https://github.com/actions/create-github-app-token/pull/54#discussion_r1344571256:

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 names[^1]:

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

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

gr2m commented 11 months ago

The way I would go about it is to release a feature version that

  1. supports both input types
  2. Logs a deprecation warning for the old notation
  3. Add a test for deprecations

Then once we release a new breaking version we can always look into the deprecations test file and remove them. It's a pattern that worked well for me in the past in several projects

smockle commented 11 months ago

Opened https://github.com/actions/create-github-app-token/pull/59 to support this.

create-app-token-action-releaser[bot] commented 11 months ago

:tada: This issue has been resolved in version 1.5.0 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: