diff --git a/.github/workflows/check-action-typing.yml b/.github/workflows/check-action-typing.yml new file mode 100644 index 0000000..90bb23b --- /dev/null +++ b/.github/workflows/check-action-typing.yml @@ -0,0 +1,19 @@ +name: Check Action Typing + +on: + - push + - pull_request + +permissions: + contents: read + +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@v2 diff --git a/README.md b/README.md index ff030f2..add684a 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,9 @@ This [Github Action](https://github.com/features/actions) displays test results ✔️ Provides final `conclusion` and counts of `passed`, `failed` and `skipped` tests as output parameters +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. + **How it looks:** |![](assets/fluent-validation-report.png)|![](assets/provider-error-summary.png)|![](assets/provider-error-details.png)|![](assets/mocha-groups.png)| |:--:|:--:|:--:|:--:| diff --git a/action-types.yml b/action-types.yml new file mode 100644 index 0000000..3cc12cd --- /dev/null +++ b/action-types.yml @@ -0,0 +1,92 @@ +# See https://github.com/typesafegithub/github-actions-typing/ +inputs: + artifact: + type: string + + name: + type: string + + path: + type: list + separator: ',' + list-item: + type: string + + path-replace-backslashes: + type: boolean + + reporter: + type: enum + allowed-values: + - dart-json + - dotnet-nunit + - dotnet-trx + - flutter-json + - java-junit + - jest-junit + - mocha-json + - rspec-json + - swift-xunit + + list-suites: + type: enum + allowed-values: + - all + - failed + - none + + list-tests: + type: enum + allowed-values: + - all + - failed + - none + + max-annotations: + type: integer + + fail-on-error: + type: boolean + + fail-on-empty: + type: boolean + + working-directory: + type: string + + only-summary: + type: boolean + + use-actions-summary: + type: boolean + + badge-title: + type: string + + token: + type: string + +outputs: + conclusion: + type: enum + allowed-values: + - success + - failure + + passed: + type: integer + + failed: + type: integer + + skipped: + type: integer + + time: + type: integer + + url: + type: string + + url_html: + type: string