Merge pull request #167 from Vampire/add-typing

Add action typing

.github/workflows/check-action-typing.yml

@@ -0,0 +1,16 @@
+name: Check Action Typing
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  check_action_typing:
+    name: Check Action Typing
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Check Action Typing
+        uses: typesafegithub/github-actions-typing@v1

Readme.md

@@ -38,6 +38,9 @@ It is a cause of failed jobs. For this case, the action `wretry.action` can retr
 - Retries actions with defined number of attempts ( default is 2 ).
 - Retries actions with defined delay between attempts ( default is 0 ).
 
+Thanks to the provided [typings](action-types.yml), it is possible to use this action in a type-safe way using
+https://github.com/typesafegithub/github-workflows-kt which allows writing workflow files using a type-safe Kotlin DSL.
+
 ## Inputs
 
 ### `action`

action-types.yml

@@ -0,0 +1,35 @@
+# See https://github.com/typesafegithub/github-actions-typing/
+inputs:
+  action:
+    type: string
+
+  command:
+    type: string
+
+  with:
+    type: string
+
+  current_path:
+    type: string
+
+  steps_context:
+    type: string
+
+  attempt_limit:
+    type: integer
+
+  attempt_delay:
+    type: integer
+
+  time_out:
+    type: integer
+
+  retry_condition:
+    type: string
+
+  github_token:
+    type: string
+
+outputs:
+  outputs:
+    type: string

main/action-types.yml

@@ -0,0 +1,35 @@
+# See https://github.com/typesafegithub/github-actions-typing/
+inputs:
+  action:
+    type: string
+
+  command:
+    type: string
+
+  with:
+    type: string
+
+  current_path:
+    type: string
+
+  steps_context:
+    type: string
+
+  attempt_limit:
+    type: integer
+
+  attempt_delay:
+    type: integer
+
+  time_out:
+    type: integer
+
+  retry_condition:
+    type: string
+
+  github_token:
+    type: string
+
+outputs:
+  outputs:
+    type: string

post/action-types.yml

@@ -0,0 +1,35 @@
+# See https://github.com/typesafegithub/github-actions-typing/
+inputs:
+  action:
+    type: string
+
+  command:
+    type: string
+
+  with:
+    type: string
+
+  current_path:
+    type: string
+
+  steps_context:
+    type: string
+
+  attempt_limit:
+    type: integer
+
+  attempt_delay:
+    type: integer
+
+  time_out:
+    type: integer
+
+  retry_condition:
+    type: string
+
+  github_token:
+    type: string
+
+outputs:
+  outputs:
+    type: string

pre/action-types.yml

@@ -0,0 +1,35 @@
+# See https://github.com/typesafegithub/github-actions-typing/
+inputs:
+  action:
+    type: string
+
+  command:
+    type: string
+
+  with:
+    type: string
+
+  current_path:
+    type: string
+
+  steps_context:
+    type: string
+
+  attempt_limit:
+    type: integer
+
+  attempt_delay:
+    type: integer
+
+  time_out:
+    type: integer
+
+  retry_condition:
+    type: string
+
+  github_token:
+    type: string
+
+outputs:
+  outputs:
+    type: string