fix: move schema-demo files to non-protected schema-demos/ folder#28838
fix: move schema-demo files to non-protected schema-demos/ folder#28838
Conversation
…e workflow Agent-Logs-Url: https://github.com/github/gh-aw/sessions/bc16bc02-153a-41f8-b642-152065b304e4 Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
|
@copilot do not create files in that folder, use another on protected folder |
…b/workflows/ Agent-Logs-Url: https://github.com/github/gh-aw/sessions/774e238f-8dac-4678-8536-c3cfc591cb9d Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Done in 91ca64c. Demo files are now created at |
There was a problem hiding this comment.
Pull request overview
Updates the Schema Feature Coverage Checker workflow instructions to avoid creating schema-demo-*.md files under the protected top-level .github/ directory by moving demo output to a new schema-demos/ folder, and recompiles the generated lock workflow.
Changes:
- Update coverage scanning to include both
.github/workflows/andschema-demos/. - Update demo file creation guidance and messaging to use
schema-demos/schema-demo-<field>.md. - Recompile
.github/workflows/schema-feature-coverage.lock.ymlto reflect workflow changes.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/schema-feature-coverage.md | Adjusts coverage instructions/grep targets and demo file destination to schema-demos/. |
| .github/workflows/schema-feature-coverage.lock.yml | Regenerated compiled lock workflow for the updated MD workflow. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 1
| For each uncovered field (process up to 10 per run; subsequent weekly runs will handle any remaining ones): | ||
|
|
||
| 1. **Create a new minimal demo workflow file** at `.github/workflows/schema-demo-<field-name>.md` | ||
| 1. **Create a new minimal demo workflow file** at `schema-demos/schema-demo-<field-name>.md` |
There was a problem hiding this comment.
schema-demos/ does not currently exist in the repository. Step 4 instructs creating schema-demos/schema-demo-<field-name>.md, which may fail for agents/tools that don’t auto-create parent directories. Either add the schema-demos/ directory to the repo (e.g., with a placeholder file) or explicitly instruct the workflow to create the directory (e.g., mkdir -p schema-demos) before writing demo files.
See below for a potential fix:
1. **Ensure the demo directory exists** by running:
```bash
mkdir -p schema-demos
- Create a new minimal demo workflow file at
schema-demos/schema-demo-<field-name>.md
(use the field name with any special characters replaced by hyphens, e.g.,disable-model-invocation→schema-demo-disable-model-invocation.md) - Include only the required minimum frontmatter needed to compile (
description,on,permissions,engine,timeout-minutes), plus the target field with a valid value - Extract the field's description from the schema using:
jq -r '.properties["<FIELD>"].description // .properties["<FIELD>"] | if type == "string" then . else "See schema for details" end' pkg/parser/schemas/main_workflow_schema.json - Write a brief markdown body explaining what the field does (use the description from the schema)
- Call
create_pull_requestwith an informative title and body
The Schema Feature Coverage Checker was 100% blocked on every run because the demo files it creates (
schema-demo-*.md) fall under.github/workflows/, which is a top-level dot-folder protected by the defaultprotect_top_level_dot_folderspolicy.Changes
.github/workflows/schema-feature-coverage.md— Updated the workflow to create demo files inschema-demos/(a non-protected folder) instead of.github/workflows/. The coverage grep (Step 2) now checks both.github/workflows/andschema-demos/so existing and new demo files both count toward coverage:Demo files are now created at
schema-demos/schema-demo-<field>.mdinstead of.github/workflows/schema-demo-<field>.md..github/workflows/schema-feature-coverage.lock.yml— Recompiled to reflect the updated workflow configuration.