Skip to content

Commit 9f0928b

Browse files
authored
docs: mention _Untyped suffix in binding class name
1 parent 7b72f3e commit 9f0928b

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/user-guide/using-actions.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,10 @@ To add a dependency on an action:
2020
3. Use the action by importing a class like `io.github.typesafegithub.workflows.actions.actions.Checkout`.
2121

2222
For every action, a binding will be generated. However, some less popular actions don't have typings configured for
23-
their inputs, so by default all inputs are of type `String`. There are two ways of configuring typings:
23+
their inputs, so by default all inputs are of type `String`, and additionally the class name will have an `_Untyped`
24+
suffix.
25+
26+
There are two ways of configuring typings:
2427
1. Recommended: a typing manifest (`action-typing.yml`) in the action's repo, see
2528
[github-actions-typing](https://github.com/typesafegithub/github-actions-typing/). Thanks to this, the actions' owner
2629
is responsible for providing and maintaining the typings defined in a technology-agnostic way, to be used
@@ -32,6 +35,9 @@ their inputs, so by default all inputs are of type `String`. There are two ways
3235
a community-maintained place to host the typings. You can contribute or fix typings for your favorite action by
3336
sending a PR.
3437

38+
Once there are typings in place, a class without the `_Untyped` suffix, and with typed constructor arguments will be
39+
available.
40+
3541
This approach supports dependency updating bots that support Kotlin Script's `.main.kts` files. E.g. Renovate is known
3642
to support it.
3743

0 commit comments

Comments
 (0)