search

DataDog / test-visibility-github-action

GitHub Action that installs Datadog Test Visibility
Apache License 2.0
3 stars 1 forks source link

Deprecated `service-name` and `api-key` inputs are marked as required #18

Closed breadadams closed 1 week ago

breadadams commented 1 week ago

It appears that the 2 deprecated inputs, service-name and api-key, are set as required, which causes this minor annoyance in my editor:

image

Hovering the red squiggly reveals why:

image

This is confusing as without coming here and looking in action.yml you'd think that api_key and service are the deprecated inputs, and that you should replace them with service-name and api-key (basically what I was about to do, before checking the source code and opening this issue 🙂).

https://github.com/DataDog/test-visibility-github-action/blob/a4ce64c0df7408dc89a965bc7f6d170a213c9c73/action.yml#L35-L43

nikita-tkachenko-datadog commented 1 week ago

The reason the old fields were marked as required and not the new ones is that otherwise all the existing users of the action would've had to change their workflows adding the new fields. I didn't know the editor displayed it the way you demonstrated though. I approved your change but I'll have to bump the major version of the action to v2 to avoid breaking things for v1 users.

breadadams commented 6 days ago

Makes sense, thanks for such a quick merge/release! 🚀