GitHub Action

YAML GitHub Actions

action.ymlaction.yaml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your action.yml and it validates in your browser — nothing is uploaded.

Validate a action.yml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`name`required	`string`	The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job.
`author`	`string`	The name of the action's author.
`description`required	`string`	A short description of the action.
`inputs`	`object`	Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended
`outputs`	`oneOf`	—
`runs`required	`oneOf`	—
`branding`	`object`	You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.
`branding.color`	`string`	The background color of the badge. one of: `"white", "black", "yellow", "blue", "green", "orange" … (+3)`
`branding.icon`	`string`	The name of the Feather icon to use. one of: `"activity", "airplay", "alert-circle", "alert-octagon", "alert-triangle", "align-center" … (+251)`

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
48 properties, 77% carrying a description, max nesting depth 13.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$comment`	JSON Schema Core, draft 2020-12	§8.3 — Comments With "$comment"
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`anyOf`	JSON Schema Core, draft 2020-12	§10.2.1.2 — "anyOf"
`const`	JSON Schema Validation, draft 2020-12	§6.1.3 — "const"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`not`	JSON Schema Core, draft 2020-12	§10.2.1.4 — "not"
`oneOf`	JSON Schema Core, draft 2020-12	§10.2.1.3 — "oneOf"
`pattern`	JSON Schema Validation, draft 2020-12	§6.3.3 — "pattern"
`patternProperties`	JSON Schema Core, draft 2020-12	§10.3.2.2 — "patternProperties"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas