{"id":13902371,"url":"https://github.com/typesafegithub/github-actions-typing","last_synced_at":"2025-07-18T00:31:25.841Z","repository":{"id":37689294,"uuid":"502427408","full_name":"typesafegithub/github-actions-typing","owner":"typesafegithub","description":"Bring type-safety to your GitHub actions' API!","archived":false,"fork":false,"pushed_at":"2024-10-30T04:00:29.000Z","size":13257,"stargazers_count":36,"open_issues_count":7,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-30T07:12:29.402Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/typesafegithub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"krzema12","custom":"https://www.buymeacoffee.com/krzema12"}},"created_at":"2022-06-11T18:32:58.000Z","updated_at":"2024-10-30T04:00:32.000Z","dependencies_parsed_at":"2023-12-01T20:35:44.784Z","dependency_job_id":"59bc23bf-1ec1-4045-acb9-5b08c2311069","html_url":"https://github.com/typesafegithub/github-actions-typing","commit_stats":{"total_commits":133,"total_committers":6,"mean_commits":"22.166666666666668","dds":0.6015037593984962,"last_synced_commit":"38f2722eacf559dffc33cfd70a36499bdc51fcb9"},"previous_names":["krzema12/github-actions-typing"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesafegithub%2Fgithub-actions-typing","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesafegithub%2Fgithub-actions-typing/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesafegithub%2Fgithub-actions-typing/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesafegithub%2Fgithub-actions-typing/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/typesafegithub","download_url":"https://codeload.github.com/typesafegithub/github-actions-typing/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226310575,"owners_count":17604602,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-06T22:01:07.340Z","updated_at":"2025-07-18T00:31:25.828Z","avatar_url":"https://github.com/typesafegithub.png","language":"Kotlin","funding_links":["https://github.com/sponsors/krzema12","https://www.buymeacoffee.com/krzema12"],"categories":["Kotlin"],"sub_categories":[],"readme":"# GitHub Actions typing\n\nBring type-safety to your GitHub actions' API!\n\nThis is a GitHub action that validates your action's type specs (`action-types.y(a)ml`) and ensures the inputs and\noutputs have types set according to a certain specification.\nIt aims to be a standardized way to present your actions' API, both to human users and any kind of automation (e. g. generating action bindings for [this Kotlin DSL](https://github.com/typesafegithub/github-workflows-kt)).\nSimilar to typings for TypeScript or type hints for Python.\n\nIt supports YAML anchors and aliases to reduce duplication.\n\nTo see which actions already provide typings using this schema, click [here](https://github.com/typesafegithub/github-actions-typing/network/dependents).\n\n# Example\n\nLet's say your action has such manifest (`action.yml`):\n\n```yaml\nname: My cool action\ndescription: Just to showcase GitHub Actions typing\ninputs:\n  verbose:\n    description: 'Set to true to display debug information helpful when troubleshooting issues with this action.'\n    required: false\n    default: 'false'\n  log-level:\n    description: 'Specify the level of details for logging.'\n    required: true\n  permissions:\n    description: 'Who should have access.'\nruns:\n  using: 'node16'\n  image: 'dist/main.js'\n```\n\nand such `action-types.yml` next to it:\n\n```yaml\ninputs:\n  verbose:\n    type: boolean\n  permissions:\n    type: inttteger\n```\n\nThis action, once used within a workflow, will fail the workflow run and produce such output:\n\n![Example output](docs/ExampleOutput.png)\n\n# Usage\n\nCreate a new file in your action repo's root directory: `action-types.yml`, then specify types for your\naction's inputs and outputs. See _\"Available types\"_ section below.\n\nFinally, create a workflow in your actions' repository that will simply call this action to validate the types:\n\n```yaml\nname: Validate action typings\n\non:\n  push:\n    branches: [main]\n  pull_request:\n  workflow_dispatch:\n\njobs:\n  validate-typings:\n    runs-on: \"ubuntu-latest\"\n    steps:\n      - uses: actions/checkout@v4\n      - uses: typesafegithub/github-actions-typing@v1\n```\n\n## Available types\n\n### String\n\nA text value.\n\nExample:\n\n```yaml\n...\ninputs:\n  name:\n    type: string\n    ...\n```\n\n### Boolean\n\nCan be `true` or `false`.\n\nExample:\n\n```yaml\n...\ninputs:\n  verbose:\n    type: boolean\n    ...\n```\n\n### Integer\n\nA number without a fractional component.\n\nExample:\n\n```yaml\n...\ninputs:\n  retries:\n    type: integer\n    ...\n```\n\nIn case of \"magic values\" meaning something else that the user would expect, you can specify them like so:\n\n```yaml\n...\ninputs:\n  fetch-depth:\n    type: integer\n    named-values:\n      infinite: 0\n    ...\n```\n\nYou can also optionally define `name` which is a hint for code generators what name can be used as class name.\n\n```yaml\n...\ninputs:\n  fetch-depth:\n    type: integer\n    name: Amount\n    named-values:\n      infinite: 0\n    ...\n```\n\n### Float\n\nA number with a fractional component.\n\nExample:\n\n```yaml\n...\ninputs:\n  threshold:\n    type: float\n    ...\n```\n\n### List\n\nA sequence of values.\n\nBecause string is used as a data type for passing inputs to actions, a separator string has to be\nspecified as well. This is usually a new line or a comma.\n\nLists can contain values of any primitive or enum type.\n\nIf your list items are in separate line each, use `\"\\n\"` as separator.\n\nExamples:\n\n```yaml\n...\ninputs:\n  input-files:\n    type: list\n    separator: ','\n    list-item:\n      type: string\n  ...\n```\n\n```yaml\n...\ninputs:\n  granted-scopes:\n    type: list\n    separator: ','\n    list-item:\n      type: enum\n      allowed-values:\n        - read\n        - write\n  ...\n```\n\n### Enum\n\nMultiple possible values.\n\nYou can also optionally define `name` which is a hint for code generators what name can be used as enum type name.\n\nExample:\n```yaml\n...\ninputs:\n  permissions:\n    type: enum\n    allowed-values:\n      - user\n      - admin\n      - guest\n  if_mention:\n    type: enum\n    name: MentionStatus\n    allowed-values:\n      - success\n      - failure\n    ...\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypesafegithub%2Fgithub-actions-typing","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypesafegithub%2Fgithub-actions-typing","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypesafegithub%2Fgithub-actions-typing/lists"}