What do you think about adding a "How do I get my ...

# github-workflows-kt

[Sebastian Schuberth]

What do you think about adding a "How do I get my own action supported by github-workflows-kt?" to the FAQ?

[Piotr Krzemiński]

"my own" -> "X" (because it's about any random action, right?)

sounds good to me!

[Piotr Krzemiński]

for clarity: by default, all actions are supported, it's just there's no typing for the inputs, so all inputs are of type String

[Piotr Krzemiński]

so the problem boils down to adding typings for some action

[Sebastian Schuberth]

Yes, but I was specifically coming from the perspective of an action author, as these might be in the position to make any changes required to the action by themselves.

[Sebastian Schuberth]

But good to hear that no changes to the action itself should be necessary at all.

[Piotr Krzemiński]

yeah, the bindings server will provide an untyped binding 👍

[Vampire]

With https://github.com/typesafegithub/github-workflows-kt/pull/1602 hopefully someday getting merged developing typings also gets more comfortable, as you then can test the typings you wrote without the need to create a release. 🙂

(https://github.com/typesafegithub/github-workflows-kt/pull/1602/files#diff-2e829cc9aea4868312c3fbc42519d9897c6e6b477cb18efc674606cea72e25c9)

[Vampire]

I always use it with a local running server for now to test a new typing I wrote and it works great 🙂

[Piotr Krzemiński]

@Vampire don't lose hope, planning to get back to it soon!

[Piotr Krzemiński]

@Sebastian Schuberth if you need help with adding typings to a specific action, let us know, happy to help

[Sebastian Schuberth]

Thanks for the offer. The FAQ entry would already help, so I can link to it from a GitHub issue in our project to motivate creating the type bindings.

[Vampire]

Well, the answer to "How do I get my own action supported by github-workflows-kt?" is, "it already is, just ..._Untyped" 🙂
To get going with the typings maybe https://typesafegithub.github.io/github-workflows-kt/user-guide/using-actions/ and https://github.com/typesafegithub/github-actions-typing (which is linked from the FAQ) is already enough?

[Vampire]

And here is an example PR that tries to add typings to an action: https://github.com/EnricoMi/publish-unit-test-result-action/pull/653/files if that might help too

[Sebastian Schuberth]

Well, the answer to "How do I get my own action supported by github-workflows-kt?" is, "it already is, just ..._Untyped" 🙂

And that's a good answer for a FAQ, IMO, as it highlights that there should be no hurdles taking github-workflows-kt into use.

[Vampire]

Well, it is described in "Using actions", but 🤷‍♂️ 🙂

[Sebastian Schuberth]

Ah, ok. Then maybe make this clear at another place then the FAQ? Or simply start the FAQ entry with "As an action author, how do I...", or separate the FAQ between sections for actions authors and action users.

[Piotr Krzemiński]

@Sebastian Schuberth if you have a spare moment, feel free to contribute to the FAQ and add a entry that you'd expect. We should probably have the instructions in a single place, and make the FAQ point to them

[Sebastian Schuberth]

Not sure when or if I'll find the time...

[Piotr Krzemiński]

ok, no worries, I'll take care of it, should be easy. Thanks for the feedback!

[Vampire]

Maybe we should also provide some list with actions that provide 1st-party typings.
That could also be helpul to convince others to on-board typings.

[Vampire]

We might soon be able to add an actions/... action to that list 🙂

[Piotr Krzemiński]

@Sebastian Schuberth see docs: add info about action support to FAQ - would it be enough? were you able to add support for the action you were after?

[Piotr Krzemiński]

Let me merge and feel free to adjust if needed

[Sebastian Schuberth]

Sorry, will have a look now, but I agree that any adjustments could be made later.