Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 30, 2025

The applyTo field in included_file_schema.json was the only root-level property lacking a description, breaking 100% documentation coverage.

Changes

  • Added root-level description to applyTo property explaining:
    • Purpose: glob pattern filtering for file/directory targeting
    • Context: used in custom agent instruction files
    • Format: supports string or array of patterns
    • Behavior: applies globally when omitted
    • Examples: **/* (all files), **/*.py (Python files)

The description follows the established pattern for other oneOf properties (network, permissions, steps) which have both root-level and variant-specific descriptions.

"applyTo": {
  "description": "Glob pattern(s) specifying which files/directories these instructions should apply to. Used in custom agent instruction files to target specific code areas. Supports wildcards (e.g., '**/*' for all files, '**/*.py' for Python files). Can be a single pattern string or array of patterns. If omitted in custom agent files, instructions apply globally.",
  "oneOf": [...]
}

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/user
    • Triggering command: /usr/bin/gh gh api user --jq .login -json GO111MODULE rg/toolchain@v0.0.1-go1.25.0.linGOMODCACHE GOINSECURE GOMOD GOMODCACHE go env -json GO111MODULE ttributes GOINSECURE GOMOD GOMODCACHE go (http block)
    • Triggering command: /usr/bin/gh gh api user --jq .login ithub/workflows om/nonexistent/repo ps GOSUMDB GOWORK 0.1-go1.25.0.lin--show-toplevel ps supe�� super-linter.git go /usr/bin/git by/d52bf793ede73/usr/bin/jq GO111MODULE 0.1-go1.25.0.linGOMODCACHE git (http block)
    • Triggering command: /usr/bin/gh gh api user --jq .login k/gh-aw/gh-aw/.github/workflows -importcfg ps by/d52bf793ede73gh -w -buildmode=exe ps oad-�� b/workflows add (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>[plan] Add description to applyTo field in included file schema</issue_title>
<issue_description>## 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

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Add description to applyTo field in included file schema Add description to applyTo field in included_file_schema.json Dec 30, 2025
Copilot AI requested a review from mnkiefer December 30, 2025 02:49
@pelikhan pelikhan marked this pull request as ready for review December 30, 2025 03:07
@pelikhan pelikhan merged commit ba9c096 into main Dec 30, 2025
4 checks passed
@pelikhan pelikhan deleted the copilot/add-description-applyto-field branch December 30, 2025 03:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants