Skip to content

Commit 43b178d

Browse files
docs: update glossary with import-schema and parameterized imports (#24267)
1 parent 2470e6f commit 43b178d

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

docs/src/content/docs/reference/glossary.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,13 @@ Natural language schedule syntax that automatically distributes workflow executi
263263

264264
### Imports
265265

266-
Reusable workflow components shared across multiple workflows. Specified in the `imports:` field, can include tool configurations, common instructions, or security guidelines.
266+
Reusable workflow components shared across multiple workflows. Specified in the `imports:` field, can include tool configurations, common instructions, or security guidelines. Shared files without an `on:` field are validated but not compiled into GitHub Actions — they are only importable by other workflows.
267+
268+
Imports support a parameterized form using `uses`/`with` syntax when the shared file declares an `import-schema`. The compiler validates the passed values, substitutes them into the shared file, and errors on conflicting imports of the same file. See [Imports Reference](/gh-aw/reference/imports/).
269+
270+
### Import Schema (`import-schema`)
271+
272+
A typed parameter contract declared in a shared workflow file that enables callers to pass values via `uses`/`with` syntax. The compiler validates each caller's `with` values against the schema and substitutes them into the shared file's frontmatter and body before processing. Supports typed fields with optional defaults; required fields without defaults cause a compile-time error if omitted. See [Imports Reference](/gh-aw/reference/imports/#import-schema-import-schema).
267273

268274
### Label Trigger Shorthand
269275

0 commit comments

Comments
 (0)