Skip to content

Request

Piotr Krzemiński edited this page Feb 4, 2023 · 9 revisions

Hi !

I'd like to ask you to add a piece of documentation. However, it won't be yet another piece of Markdown. When working with various actions, I discovered that it's challenging to know what kind of data is needed for the inputs of an action, the same for outputs. Every action has its own custom way of documenting it, if it documents it at all. I figured there must be a way to address it.

I looked for an inspiration in other ecosystems where types were added later, like TypeScript adding types for JavaScript, or type hints in the Python world. I decided to create github-actions-typing which aspires to be the standardized way of typing your action's API. Onboarding is as easy as adding an extra YAML file to your repository root, and (optionally, although highly recommended) adding a simple GitHub workflow that validates this new file. It has no negative effects on current action consumers, they continue to use the action as if the file wasn't there.

Clone this wiki locally