Skip to content

docs: document infrastructure workflows and VS Code tooling #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
github-actions wants to merge 1 commit into from
+24 −0
Closed

docs: document infrastructure workflows and VS Code tooling #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

```
Expand Down
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down