search

typesafegithub / github-actions-typing-catalog

Typings for GitHub actions
2 stars 2 forks source link

Review current output types #30

Open Vampire opened 3 weeks ago

Vampire commented 3 weeks ago

These 85 of 139 current typing files have outputs defined. They should be verified for correct type, now that maybe we soon get typed outputs support in github-workflows-kt :-) As changing those types is a potentially breaking change, it should best be done before the v3 release that make the Maven bindings stable and mandatory. If they cannot be reviewed in time, maybe the outputs should be removed from the typing as you then get only the _Untyped fields and then later defining the correct type will be a backwards compatible change.

krzema12 commented 3 weeks ago

@Vampire As discussed offline, I'm all for making it right!

Just one question: typings/tecolicom/actions-use-homebrew-tools/v1/action-types.yml on your list, where does it come from? Maybe you haven't contributed it to the repo?

krzema12 commented 3 weeks ago

BTW, my one-liner for generating the list is grep -Rl "outputs:" typings | sort, your list is already a bit outdated, but I'm going to use a fresh one when I perform this task.

Vampire commented 3 weeks ago

I did have contributed it, but you removed it again as upstream PR was accepted in time a week ago :-)

But that's is probably the only error in my list. You have to add ^ as start of your pattern or you get inputs and outputs called outputs in the result. My one-liner for the list was similar. :-)

Vampire commented 3 weeks ago

This is my one-liner to right away get the checkboxes / task list: git grep -l '^outputs:' | sed 's/^/- [ ] /' :-)