Skip to content

Commit

Permalink
Merge pull request #5 from Vampire/main
Browse files Browse the repository at this point in the history
add action typing
  • Loading branch information
kaz-utashiro authored Aug 19, 2024
2 parents 8a51b98 + 551e668 commit 14ab4bd
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .github/workflows/check-action-typing.yml
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ add `/Applications` and/or `/Library` directories.
Output is same as
[`@actions/cache`](https://github.com/actions/cache).

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.

## Usage

```yaml
Expand Down
30 changes: 30 additions & 0 deletions action-types.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# See https://github.com/typesafegithub/github-actions-typing/
inputs:
tools:
type: list
separator: ' '
list-item:
type: string

key:
type: string

path:
type: list
separator: ' '
list-item:
type: string

cache:
type: enum
allowed-values:
- yes
- no
- workflow

verbose:
type: boolean

outputs:
cache-hit:
type: boolean

0 comments on commit 14ab4bd

Please sign in to comment.