Skip to content

[plan] Add description to applyTo field in included file schema #8134

@github-actions

Description

@github-actions

Objective

Add a description to the applyTo field in included_file_schema.json, which is currently the only root-level property missing documentation.

Context

This is Issue #2 (Medium) from the schema audit. The applyTo field is the only root-level property without a description, breaking the otherwise perfect 100% documentation coverage.

Approach

In pkg/parser/schemas/included_file_schema.json, locate the applyTo property definition and add a description field.

Files to Modify

  • pkg/parser/schemas/included_file_schema.json

Implementation

Add description explaining that applyTo is a glob pattern that filters which jobs use this included file:

"applyTo": {
  "description": "Glob pattern specifying which jobs should use this included file. Supports wildcards (e.g., '**/*' for all jobs, 'test-*' for jobs starting with 'test'). If omitted, applies to all jobs.",
  "type": "string"
}

Acceptance Criteria

  • applyTo field has a clear, helpful description
  • Description explains glob pattern support and filtering behavior
  • Description mentions what happens when field is omitted
  • Schema validation still passes
  • Run make build to verify embedded schema compiles

Estimated Effort

5 minutes

AI generated by Plan Command for discussion #8130

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions