Skip to content

Commit f054313

Browse files
authored
README: specify that whole action's API must be typed (#444)
Added note about required typings for inputs and outputs. Closes #443.
1 parent 2b386b8 commit f054313

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ outputs have types set according to a certain specification.
77
It aims to be a standardized way to present your actions' API, both to human users and any kind of automation (e. g. generating action bindings for [this Kotlin DSL](https://github.com/typesafegithub/github-workflows-kt)).
88
Similar to typings for TypeScript or type hints for Python.
99

10+
Typings for all inputs and outputs have to be specified.
11+
1012
It supports YAML anchors and aliases to reduce duplication.
1113

1214
To see which actions already provide typings using this schema, click [here](https://github.com/typesafegithub/github-actions-typing/network/dependents).

0 commit comments

Comments
 (0)