From 73367f1838f7354e271c44cf15fed24e5ef1d488 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 19 Apr 2026 22:45:14 +0000 Subject: [PATCH] docs: document infrastructure workflows and VS Code tooling MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Two workflow files and the .vscode/ directory existed but were absent from all documentation — a contributor scanning .github/workflows/ saw 9 files while the README only accounted for 7. README.md: - Add agentics-maintenance.yml and copilot-setup-steps.yml to the repository layout code block with inline comments - Add .vscode/ directory (mcp.json, settings.json) to the layout - Add "Infrastructure workflows" section explaining both files: agentics-maintenance.yml is auto-generated (do not edit by hand); copilot-setup-steps.yml pre-installs gh-aw for Copilot Agent sessions CONTRIBUTING.md: - Add "VS Code + GitHub Copilot" subsection under Development setup describing what .vscode/mcp.json and .vscode/settings.json provide and that they activate automatically (no manual steps) Supersedes PR #6, which carried the same changes but accumulated merge conflicts as PRs #8–#15 landed on main. Co-Authored-By: Claude Sonnet 4.6 --- CONTRIBUTING.md | 9 +++++++++ README.md | 15 +++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f3d9b58..ccc0791 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,6 +19,15 @@ claude --plugin-dir . `--plugin-dir .` tells Claude Code to load the plugin manifest from `.claude-plugin/plugin.json` and discover skills in `skills/*/SKILL.md`. The plugin runs entirely locally — no build step, no compilation. +### VS Code + GitHub Copilot + +If you use VS Code, two configuration files activate automatically when you open the repository: + +- `.vscode/mcp.json` — registers `gh aw mcp-server` as an MCP server named `github-agentic-workflows`, giving Copilot Agent access to gh-aw tooling without any manual setup. +- `.vscode/settings.json` — enables GitHub Copilot for Markdown files so you get completions and inline chat while editing skill and workflow sources. + +No manual activation is needed. + ## How the plugin works ``` diff --git a/README.md b/README.md index 683652b..16d863f 100644 --- a/README.md +++ b/README.md @@ -136,10 +136,25 @@ skills/ weekly-research.{md,lock.yml} shared/ reporting.md # shared reporting component (run-link formatting) + agentics-maintenance.yml # auto-generated; manages expiry and maintenance ops + copilot-setup-steps.yml # installs gh-aw for Copilot Agent sessions + +.vscode/ + mcp.json # MCP server config (gh aw mcp-server) for VS Code + settings.json # enables GitHub Copilot for Markdown ``` `.lock.yml` files are marked as `linguist-generated` and `merge=ours` in `.gitattributes` to prevent spurious merge conflicts. +## Infrastructure workflows + +Two files in `.github/workflows/` support the toolchain but are not agentic workflows themselves: + +| File | How created | Purpose | +|---|---|---| +| `agentics-maintenance.yml` | Auto-generated by `gh aw compile` | Runs every 6 hours to close expired issues/discussions/PRs created by agentic workflows, clean cache-memory entries, and handle on-demand operations (`disable`, `enable`, `upgrade`, `safe_outputs`, etc.). **Do not edit by hand** — it is regenerated on every `gh aw compile` run. | +| `copilot-setup-steps.yml` | Hand-authored | Pre-installs the `gh aw` CLI extension in GitHub Copilot Agent sessions so Copilot has `gh aw` tooling available without manual setup. Triggers on push to the file itself and on `workflow_dispatch`. | + ## Local development ```bash