GitHub Actions typing
Bring type-safety to your GitHub actions' API!
This is a GitHub action that validates your action's type specs (action-types.y(a)ml) and ensures the inputs and outputs have types set according to a certain specification.
To see which actions already provide typings using this schema, click here.
Example
Let's say your action has such manifest (action.yml):
name: My cool action
description: Just to showcase GitHub Actions typing
inputs:
verbose:
description: 'Set to true to display debug information helpful when troubleshooting issues with this action.'
required: false
default: 'false'
log-level:
description: 'Specify the level of details for logging.'
required: true
permissions:
description: 'Who should have access.'
runs:
using: 'node16'
image: 'dist/main.js'
and such action-types.yml next to it:
inputs:
verbose:
type: boolean
permissions:
type: inttteger
This action, once used within a workflow, will fail the workflow run and produce such output:
Usage
Create a new file in your action repo's root directory: action-types.yml, then specify types for your action's inputs and outputs. See "Available types" section below.
Finally, create a workflow in your actions' repository that will simply call this action to validate the types:
name: Validate action typings
on:
push: [main]
pull_request:
workflow_dispatch:
jobs:
validate-typings:
runs-on: "ubuntu-latest"
steps:
- uses: actions/checkout@v3
- uses: krzema12/github-actions-typing@v0
Available types
String
A text value.
Example:
...
inputs:
name:
type: string
...
Boolean
Can be true or false.
Example:
...
inputs:
verbose:
type: boolean
...
Integer
A number without a fractional component.
Example:
...
inputs:
retries:
type: integer
...
In case of "magic values" meaning something else that the user would expect, you can specify them like so:
...
inputs:
fetch-depth:
type: integer
named-values:
infinite: 0
...
Float
A number with a fractional component.
Example:
...
inputs:
threshold:
type: float
...
List
A sequence of values.
Because string is used as a data type for passing inputs to actions, a separator string has to be specified as well. This is usually a new line or a comma.
Lists can contain values of any primitive or enum type.
Examples:
...
inputs:
input-files:
type: list
separator: ','
list-item:
type: string
...
...
inputs:
granted-scopes:
type: list
separator: ','
list-item:
type: enum
allowed-values:
- read
- write
...
Enum
Multiple possible values.
Example:
...
inputs:
permissions:
type: enum
allowed-values:
- user
- admin
- guest
...
4 Sep 11, 2022
1 Dec 12, 2021
1 Jan 19, 2022
162 Dec 27, 2022
58 Oct 21, 2022
0 Apr 16, 2022
2 Mar 4, 2022
3 Jan 1, 2022
7 Dec 21, 2022
21 Dec 3, 2022
3 Aug 5, 2022
3 Aug 24, 2021
5 Jul 7, 2021
2 Nov 11, 2021
0 Oct 6, 2021
10 Jun 3, 2022
0 Nov 30, 2021
0 Dec 28, 2021
1 Nov 26, 2022