Skip to content
Merged
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions workshop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,24 @@ A hands-on workshop that takes you from zero to a fully automated, AI-powered wo
- [Agentic Workflows for GitHub Actions Power Users](side-quest-05-01-actions-power-user.md) — one-page cheat sheet for what changes vs what stays the same in agentic workflows; branches from [Step 5](05-agentic-workflows-intro.md).
- [Agentic Workflows Deep Dive](side-quest-05-02-aw-deep-dive.md) — classification exercises, example agent output, the two-file structure, and concept checks; branches from [Step 5](05-agentic-workflows-intro.md).
- [Terminal Basics](side-quest-01-01-terminal-basics.md) — optional primer that branches from [Step 1](01-prerequisites.md).
- [Enterprise Setup Considerations](side-quest-enterprise-setup.md) — required reading for GHES users and useful for any managed enterprise environment; common return points include [Step 1](01-prerequisites.md), [Step 2a](02a-setup-codespace.md), [Step 2b](02b-setup-local.md), and [Step 5](05-agentic-workflows-intro.md).
- [Environment Reference](side-quest-01-02-environment-reference.md) — glossary of workshop environments and tool terms with official docs links; branches from [Step 1](01-prerequisites.md).
- [Permission Errors](side-quest-01-03-permission-errors.md) — troubleshooting guide for `permission denied` errors encountered during terminal-based steps; branches from [Step 1](01-prerequisites.md).
- [Install `gh-aw` Troubleshooting](side-quest-06-01-install-troubleshooting.md) — optional install troubleshooting reference that branches from [Step 6](06-install-gh-aw.md).
- [Use `gh-aw` with the GitHub Copilot Cloud Agent](side-quest-06-02-cca-codespace.md) — how to open a terminal inside the Copilot Cloud Agent Codespace so `gh-aw` CLI commands work; branches from [Step 6](06-install-gh-aw.md).
- [Using `gh aw compile` to Catch Errors Early](side-quest-07-01-compile-workflow.md) — quick reference for `gh aw compile`, `--validate`, `--watch`, and common compile errors; branches from [Step 7](07-your-first-workflow.md), [Step 11a](07-your-first-workflow.md), or [Step 12](12-test-and-iterate.md).
- [Fix Codespaces `actions:write` Errors When Running `gh aw run`](side-quest-08-01-codespaces-actions-write.md) — troubleshooting guide for Codespaces workflow-trigger permission errors with a UI-first path and advanced recovery path; branches from [Step 8](08-run-your-workflow.md).
- [Diagnosing Common Agent Output Patterns](side-quest-09-01-debug-output.md) — expanded troubleshooting guide for the five most common log patterns; branches from [Step 9](08b-interpret-your-run.md).
- [Pattern: Long `[plan]` Chains](side-quest-09-01a-pattern-long-plan-chain.md) — how to spot a planning loop and rewrite your workflow brief so the agent starts with an explicit first tool call; branches from [Diagnosing Common Agent Output Patterns](side-quest-09-01-debug-output.md).
- [Pattern: Empty `[result]` Data](side-quest-09-01b-pattern-empty-results.md) — how to diagnose empty tool responses and decide whether the root cause is missing read scope, over-filtering, or truly empty repository data; branches from [Diagnosing Common Agent Output Patterns](side-quest-09-01-debug-output.md).
- [Pattern: `safe-output: BLOCKED`](side-quest-09-01c-pattern-safe-output-blocked.md) — how to interpret blocked writes and choose between increasing allowed outputs or constraining agent behavior; branches from [Diagnosing Common Agent Output Patterns](side-quest-09-01-debug-output.md).
- [Pattern: `permission denied`](side-quest-09-01d-pattern-permission-denied.md) — how to map permission failures to the correct control: read access in `permissions:` and write allowlisting in `safe-outputs:`; branches from [Diagnosing Common Agent Output Patterns](side-quest-09-01-debug-output.md).
- [Pattern: "Done" but Nothing Written](side-quest-09-01e-pattern-done-no-write.md) — how to diagnose successful runs that produce no write output and tighten instructions so expected writes happen reliably; branches from [Diagnosing Common Agent Output Patterns](side-quest-09-01-debug-output.md).
- [Debugging Checklist](side-quest-09-01f-debugging-checklist.md) — a repeatable seven-step triage flow to apply whenever a run produces unexpected output; branches from [Diagnosing Common Agent Output Patterns](side-quest-09-01-debug-output.md).
- [Writing a Clear Agent Brief](side-quest-10-01-agent-brief.md) — five-step framework for designing any agentic workflow brief; branches from [Step 10](09-agentic-editing.md).
- [Jailbreaking the Agent Brief](side-quest-10-02-jailbreak-brief.md) — explains how adversarial instructions embedded in repository content attempt to override the agent's task brief, and how the compiled brief, minimal `permissions:`, `safe-outputs`, and `network.allowed-domains` contain any partial success; branches from [Step 10](09-agentic-editing.md).
- [Frontmatter Deep Dive — Part A](side-quest-11-01-frontmatter-deep-dive.md) — walkthrough of the opening, trigger, and permissions sections of `gh-aw` frontmatter, with predict-and-try activities; branches from [Step 11a](07-your-first-workflow.md).
- [Workflow File Structure at a Glance](side-quest-11-01b-workflow-structure.md) — visual map of the two-file structure (`.md` + `.lock.yml`), the frontmatter sections, and the Markdown body; branches from [Step 7a](07a-your-first-workflow-terminal.md).
- [Frontmatter Deep Dive — Part B](side-quest-11-08-frontmatter-tools-outputs.md) — walkthrough of the tools, safe-outputs, closing fence, and agent body sections, with predict-and-try activities; continues from Part A.
- [Pattern: Auto-Label PRs by Content](side-quest-13-01-pr-labeler-pattern.md) — apply labels automatically based on which files changed in a pull request; branches from [Step 14b](14b-pr-reviewer-workflow.md).
- [Pattern: Generate a PR Summary Comment](side-quest-13-02-pr-summary-pattern.md) — post a structured, changelog-ready summary comment when a pull request opens; branches from [Step 14b](14b-pr-reviewer-workflow.md).
Expand All @@ -84,6 +94,9 @@ A hands-on workshop that takes you from zero to a fully automated, AI-powered wo
- [Output Injection via Safe Outputs](side-quest-17-06-output-injection.md) — explains how crafted repository content can embed misleading markdown into agent output to fool human reviewers, and how `safe-outputs` surface declarations and label scoping prevent it; branches from [Step 17](17-add-mcp-tools.md).
- [Repository Poisoning via Agentic Write Access](side-quest-17-07-repo-poisoning.md) — explains how a misdirected agent granted `contents: write` could be tricked into committing backdoors or overwriting sensitive files, and how `contents: read`, `protected-files`, and `safe-outputs: create-pull-request` close that path entirely; branches from [Step 17](17-add-mcp-tools.md).
- [Configure GitHub Copilot for Agentic Workflows](side-quest-06-03-copilot-token.md) — explains organization centralized billing and personal `COPILOT_GITHUB_TOKEN` billing; branches from [Step 7d](07d-confirm-model-access.md).
- [Method 1 — Copilot Requests Permission](side-quest-06-03a-copilot-requests-permission.md) — use this when your organization has centralized Copilot billing enabled for GitHub Actions; branches from [Configure GitHub Copilot for Agentic Workflows](side-quest-06-03-copilot-token.md).
- [Method 2 — `COPILOT_GITHUB_TOKEN` Secret](side-quest-06-03b-copilot-github-token.md) — use this for personal billing or when centralized Copilot billing is not enabled; branches from [Configure GitHub Copilot for Agentic Workflows](side-quest-06-03-copilot-token.md).
- [Method 2 (UI-only) — `COPILOT_GITHUB_TOKEN` Secret](side-quest-06-03c-copilot-github-token-ui-only.md) — complete personal-billing setup using only the GitHub web UI, without terminal commands; branches from [Configure GitHub Copilot for Agentic Workflows](side-quest-06-03-copilot-token.md).
- [Configure an Anthropic API Key](side-quest-11-06-anthropic-key.md) — step-by-step guide to generating an Anthropic key, storing it as a repository secret, and switching your workflow to `engine: claude`; branches from [Step 11a](07-your-first-workflow.md).
- [Configure an OpenAI API Key](side-quest-11-07-openai-key.md) — step-by-step guide to generating an OpenAI key, storing it as a repository secret, and switching your workflow to `engine: codex`; branches from [Step 11a](07-your-first-workflow.md).
- [Choosing Between Cache Memory and Repo Memory](side-quest-20-01-memory-patterns.md) — decision guide, full field references, and example task briefs for both `cache-memory` and `repo-memory`; branches from [Step 20](20-persistent-memory.md).
Expand Down