diff --git a/docs/src/content/docs/examples/multi-repo.md b/docs/src/content/docs/examples/multi-repo.mdx similarity index 89% rename from docs/src/content/docs/examples/multi-repo.md rename to docs/src/content/docs/examples/multi-repo.mdx index 372813d2e2b..615db93b5c0 100644 --- a/docs/src/content/docs/examples/multi-repo.md +++ b/docs/src/content/docs/examples/multi-repo.mdx @@ -3,6 +3,8 @@ title: Multi-Repository Examples description: Complete examples for managing workflows across multiple GitHub repositories, including feature synchronization, cross-repo tracking, and organization-wide updates. --- +import { Icon } from '@astrojs/starlight/components'; + Multi-repository operations enable coordinating work across multiple GitHub repositories while maintaining security and proper access controls. These examples demonstrate common patterns for cross-repo workflows. ## Featured Examples @@ -90,14 +92,14 @@ Most safe output types support the `target-repo` parameter for cross-repository | Safe Output | Cross-Repo Support | Example Use Case | |-------------|-------------------|------------------| -| `create-issue` | ✅ | Create tracking issues in central repo | -| `add-comment` | ✅ | Comment on issues in other repos | -| `update-issue` | ✅ | Update issue status across repos | -| `add-labels` | ✅ | Label issues in target repos | -| `create-pull-request` | ✅ | Create PRs in downstream repos | -| `create-discussion` | ✅ | Create discussions in any repo | -| `create-agent-session` | ✅ | Create tasks in target repos | -| `update-release` | ✅ | Update release notes across repos | +| `create-issue` | | Create tracking issues in central repo | +| `add-comment` | | Comment on issues in other repos | +| `update-issue` | | Update issue status across repos | +| `add-labels` | | Label issues in target repos | +| `create-pull-request` | | Create PRs in downstream repos | +| `create-discussion` | | Create discussions in any repo | +| `create-agent-session` | | Create tasks in target repos | +| `update-release` | | Update release notes across repos | **Configuration Example:** diff --git a/docs/src/content/docs/guides/editing-workflows.md b/docs/src/content/docs/guides/editing-workflows.mdx similarity index 81% rename from docs/src/content/docs/guides/editing-workflows.md rename to docs/src/content/docs/guides/editing-workflows.mdx index b7a1c03c0c1..e778f7769a9 100644 --- a/docs/src/content/docs/guides/editing-workflows.md +++ b/docs/src/content/docs/guides/editing-workflows.mdx @@ -5,6 +5,8 @@ sidebar: order: 5 --- +import { Icon } from '@astrojs/starlight/components'; + Agentic workflows consist of two distinct parts with different editing requirements: the **YAML frontmatter** (configuration) and the **markdown body** (AI instructions). Understanding when changes require recompilation helps you iterate quickly and efficiently. See [Creating Agentic Workflows](/gh-aw/setup/creating-workflows/) for guidance on creating workflows with AI assistance. @@ -87,7 +89,7 @@ For priority, consider: - `low-priority`: Nice-to-have improvements, minor enhancements ``` -✅ This change takes effect immediately without recompilation. + This change takes effect immediately without recompilation. ## Editing With Recompilation Required @@ -141,7 +143,7 @@ tools: --- ``` -⚠️ Run `gh aw compile my-workflow` before committing this change. + Run `gh aw compile my-workflow` before committing this change. ## Expressions and Environment Variables @@ -172,7 +174,7 @@ These expressions are evaluated at runtime and validated for security. See [Temp Arbitrary expressions are blocked for security. This will fail at runtime: ```markdown -# ❌ WRONG - Will be rejected +# WRONG - Will be rejected Run this command: ${{ github.event.comment.body }} ``` @@ -182,17 +184,17 @@ Use `needs.activation.outputs.text` for sanitized user input instead. | Change Type | Example | Recompilation? | Edit Location | |-------------|---------|----------------|---------------| -| **AI instructions** | Add task steps | ❌ No | GitHub.com or any editor | -| **Output templates** | Change issue format | ❌ No | GitHub.com or any editor | -| **Conditional logic** | "If bug, then..." | ❌ No | GitHub.com or any editor | -| **GitHub expressions** | Add `${{ github.actor }}` | ❌ No | GitHub.com or any editor | -| **Tools** | Add GitHub toolset | ✅ Yes | Local + compile | -| **Permissions** | Add `contents: write` | ✅ Yes | Local + compile | -| **Triggers** | Add `schedule:` | ✅ Yes | Local + compile | -| **Network rules** | Add allowed domain | ✅ Yes | Local + compile | -| **Safe outputs** | Add `create-issue:` | ✅ Yes | Local + compile | -| **Engine** | Change to Claude | ✅ Yes | Local + compile | -| **Imports** | Add shared config | ✅ Yes | Local + compile | +| **AI instructions** | Add task steps | No | GitHub.com or any editor | +| **Output templates** | Change issue format | No | GitHub.com or any editor | +| **Conditional logic** | "If bug, then..." | No | GitHub.com or any editor | +| **GitHub expressions** | Add `${{ github.actor }}` | No | GitHub.com or any editor | +| **Tools** | Add GitHub toolset | Yes | Local + compile | +| **Permissions** | Add `contents: write` | Yes | Local + compile | +| **Triggers** | Add `schedule:` | Yes | Local + compile | +| **Network rules** | Add allowed domain | Yes | Local + compile | +| **Safe outputs** | Add `create-issue:` | Yes | Local + compile | +| **Engine** | Change to Claude | Yes | Local + compile | +| **Imports** | Add shared config | Yes | Local + compile | ## Related Documentation diff --git a/docs/src/content/docs/guides/packaging-imports.md b/docs/src/content/docs/guides/packaging-imports.mdx similarity index 94% rename from docs/src/content/docs/guides/packaging-imports.md rename to docs/src/content/docs/guides/packaging-imports.mdx index 23445989e7c..a8702735a33 100644 --- a/docs/src/content/docs/guides/packaging-imports.md +++ b/docs/src/content/docs/guides/packaging-imports.mdx @@ -5,6 +5,8 @@ sidebar: order: 2 --- +import { Icon } from '@astrojs/starlight/components'; + ## Adding Workflows Install workflows from external repositories with optional versioning: @@ -73,15 +75,15 @@ Main Workflow | Field | Merge Strategy | Main Workflow Precedence | |-------|---------------|-------------------------| | `tools:` | Deep merge, arrays concatenate | Keys merged, arrays deduplicated | -| `mcp-servers:` | Override by name | ❌ Imported servers override | -| `network:` | Union of allowed domains | ✅ Mode and firewall settings | -| `permissions:` | Validation only | ✅ Main must explicitly declare | -| `safe-outputs:` | Type-level override | ✅ Main overrides imported types | +| `mcp-servers:` | Override by name | Imported servers override | +| `network:` | Union of allowed domains | Mode and firewall settings | +| `permissions:` | Validation only | Main must explicitly declare | +| `safe-outputs:` | Type-level override | Main overrides imported types | | `safe-outputs.jobs:` | Conflict detection | Neither (names must be unique) | -| `runtimes:` | Version override | ✅ Main versions override | +| `runtimes:` | Version override | Main versions override | | `services:` | Conflict detection | Neither (must be unique) | | `steps:` | Array prepend | Imported first, then main | -| `jobs:` | Not importable | ✅ Main only (ignored in imports) | +| `jobs:` | Not importable | Main only (ignored in imports) | **Example: Tool merging** ```yaml wrap diff --git a/docs/src/content/docs/patterns/multirepoops.md b/docs/src/content/docs/patterns/multirepoops.mdx similarity index 92% rename from docs/src/content/docs/patterns/multirepoops.md rename to docs/src/content/docs/patterns/multirepoops.mdx index 6f9fc35cc4f..1e7c9fbb5d2 100644 --- a/docs/src/content/docs/patterns/multirepoops.md +++ b/docs/src/content/docs/patterns/multirepoops.mdx @@ -5,6 +5,8 @@ sidebar: badge: { text: 'Advanced', variant: 'caution' } --- +import { Icon } from '@astrojs/starlight/components'; + MultiRepoOps extends operational automation patterns (IssueOps, ChatOps, etc.) across multiple GitHub repositories. Using cross-repository safe outputs and secure authentication, MultiRepoOps enables coordinating work between related projects—creating tracking issues in central repos, synchronizing features to sub-repositories, and enforcing organization-wide policies—all through AI-powered workflows. ## When to Use MultiRepoOps @@ -135,14 +137,14 @@ Most safe output types support the `target-repo` parameter for cross-repository | Safe Output | Cross-Repo Support | Example Use Case | |-------------|-------------------|------------------| -| `create-issue` | ✅ | Create tracking issues in central repo | -| `add-comment` | ✅ | Comment on issues in other repos | -| `update-issue` | ✅ | Update issue status across repos | -| `add-labels` | ✅ | Label issues in target repos | -| `create-pull-request` | ✅ | Create PRs in downstream repos | -| `create-discussion` | ✅ | Create discussions in any repo | -| `create-agent-session` | ✅ | Create tasks in target repos | -| `update-release` | ✅ | Update release notes across repos | +| `create-issue` | | Create tracking issues in central repo | +| `add-comment` | | Comment on issues in other repos | +| `update-issue` | | Update issue status across repos | +| `add-labels` | | Label issues in target repos | +| `create-pull-request` | | Create PRs in downstream repos | +| `create-discussion` | | Create discussions in any repo | +| `create-agent-session` | | Create tasks in target repos | +| `update-release` | | Update release notes across repos | ## Teaching Agents Multi-Repo Access diff --git a/docs/src/content/docs/setup/cli.md b/docs/src/content/docs/setup/cli.mdx similarity index 99% rename from docs/src/content/docs/setup/cli.md rename to docs/src/content/docs/setup/cli.mdx index 331c5f2f4eb..d3e94173fb1 100644 --- a/docs/src/content/docs/setup/cli.md +++ b/docs/src/content/docs/setup/cli.mdx @@ -5,9 +5,11 @@ sidebar: order: 200 --- +import { Icon } from '@astrojs/starlight/components'; + The `gh aw` CLI extension enables developers to create, manage, and execute AI-powered workflows directly from the command line. It transforms natural language markdown files into GitHub Actions. -## 🚀 Most Common Commands +## Most Common Commands Most users only need these 6 commands: diff --git a/docs/src/content/docs/setup/creating-workflows.mdx b/docs/src/content/docs/setup/creating-workflows.mdx index c07df45e93b..124fce97017 100644 --- a/docs/src/content/docs/setup/creating-workflows.mdx +++ b/docs/src/content/docs/setup/creating-workflows.mdx @@ -16,7 +16,7 @@ In this guide, we show you how to create agentic workflows in the GitHub web int src="/gh-aw/videos/create-workflow-on-github.mp4" caption="Create an agentic workflow from the GitHub web interface" aspectRatio="16:9" - thumbnail="/gh-aw/images/create-workfow-github-thumbnail.png" + thumbnail="/gh-aw/videos/create-workflow-on-github.png" /> ## Creating Agentic Workflows using a Coding Agent diff --git a/docs/src/content/docs/setup/quick-start.md b/docs/src/content/docs/setup/quick-start.md deleted file mode 100644 index 89b7aefb9fc..00000000000 --- a/docs/src/content/docs/setup/quick-start.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: Quick Start -description: Get your first agentic workflow running in minutes. Install the extension, add a sample workflow, set up secrets, and run your first AI-powered automation. -sidebar: - order: 1 ---- - -## Adding an Automated Daily Status Workflow to Your Repo - -In this guide you will add the automated [**Daily Repo Status Report**](https://github.com/githubnext/agentics/blob/main/workflows/daily-repo-status.md?plain=1) to an existing GitHub repository where you are a maintainer, running in GitHub Actions. - -The aim here is **automated AI**: to install something that will run **automatically** every day, in the context of your repository. The workflow will regularly create or update a fresh status report issue in your repository, without any further manual intervention. If you're familiar with GitHub Actions, you will be aware of the power of automation in repositories; this is simply taking that to the next level with AI. - -## Prerequisites - -Before installing, ensure you have: - -- ✅ **AI Account** - A [GitHub Copilot](https://github.com/features/copilot) subscription, or a [Anthropic Claude](https://www.anthropic.com/) or [OpenAI Codex](https://openai.com/api/) API key -- ✅ **GitHub Repository** - a GitHub repository you are maintainer on -- ✅ **GitHub Actions** enabled in your repository -- ✅ **GitHub CLI** (`gh`) - A command-line tool for GitHub. [Install here](https://cli.github.com) v2.0.0+ -- ✅ **Operating System**: Linux, macOS, or Windows with WSL - -### Step 1 — Install the extension - -Install the [GitHub CLI](https://cli.github.com/), then install the GitHub Agentic Workflows extension: - -```bash wrap -gh extension install github/gh-aw -`` -`> [!TIP] -> If you are encountering authentication issues, use this script, -> ``` -> curl -sL https://raw.githubusercontent.com/github/gh-aw/main/install-gh-aw.sh | bash -> ``` - -### Step 2 — Add the sample workflow and trigger a run - -From your repository root run: - -```bash wrap -gh aw add githubnext/agentics/daily-repo-status -``` - -This will take you through an interactive process to: - -1. **Select an AI Engine** - You'll be prompted to choose between Claude, Copilot, or Codex -2. **Add the workflow** - Configure your first agentic workflow -3. **Set up required secrets** - If needed, you'll be prompted to create/add them now -4. **Trigger an initial run** - Start the workflow immediately to see it in action - -Once your initial run is complete, a new issue will be created in your repository with a "repo status report". The report will be automatically generated by the AI based on recent activity in your repository, including issues, PRs, discussions, releases, and code changes. It will analyze: - -- Recent repository activity (issues, PRs, discussions, releases, code changes) -- Progress tracking, goal reminders and highlights -- Project status and recommendations -- Actionable next steps for maintainers - -
-
- -
-
Install the extension, add a workflow, and trigger a run from the CLI
-
- -### Going further — Customize your workflow - -Your automated agent is fully customizable. If you like, you can customize it now: - -1. Edit the workflow markdown file located at `.github/workflows/daily-repo-status.md` in your repository. - -2. Regenerate the workflow YAML by running: - - ```bash - gh aw compile - ``` - -3. Commit and push to your repository. - -4. You can now optionally trigger another run by running: - - ```bash - gh aw run daily-repo-status - ``` - -Some ideas for customization: - -- Adjust the schedule to run more or less frequently -- Modify the style or content of the report -- Adjust the instructions to analyze patterns in failed CI runs or test coverage -- Request analysis of compliance with organizational standards -- Request analysis of ways the repository could be modernized or simplified - -## What's next? - -There are hundreds of other ways to use GitHub Agentic Workflows. Explore these in [Peli's Agent Factory](https://github.github.com/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/). - -Or continue learning with these resources: - -- [Creating Agentic Workflows](/gh-aw/setup/creating-workflows/) -- [How Agentic Workflows Work](/gh-aw/introduction/how-they-work/) -- [Frequently Asked Questions](/gh-aw/reference/faq/) diff --git a/docs/src/content/docs/setup/quick-start.mdx b/docs/src/content/docs/setup/quick-start.mdx index b266f195144..7e00f69eb43 100644 --- a/docs/src/content/docs/setup/quick-start.mdx +++ b/docs/src/content/docs/setup/quick-start.mdx @@ -6,6 +6,7 @@ sidebar: --- import Video from '../../../components/Video.astro'; +import { Icon } from '@astrojs/starlight/components'; ## Adding an Automated Daily Status Workflow to Your Repo @@ -17,18 +18,18 @@ The aim here is **automated AI**: to install something that will run **automatic src="/gh-aw/videos/install-and-add-workflow-in-cli.mp4" caption="Install the extension, add a workflow, and trigger a run from the CLI" aspectRatio="16:9" - thumbnail="/gh-aw/images/install-and-add-workflow-in-cli-thumbnail.png" + thumbnail="/gh-aw/videos/install-and-add-workflow-in-cli.png" /> ## Prerequisites Before installing, ensure you have: -- ✅ **AI Account** - A [GitHub Copilot](https://github.com/features/copilot) subscription, or a [Anthropic Claude](https://www.anthropic.com/) or [OpenAI Codex](https://openai.com/api/) API key -- ✅ **GitHub Repository** - a GitHub repository you are maintainer on -- ✅ **GitHub Actions** enabled in your repository -- ✅ **GitHub CLI** (`gh`) - A command-line tool for GitHub. [Install here](https://cli.github.com) v2.0.0+ -- ✅ **Operating System**: Linux, macOS, or Windows with WSL +- **AI Account** - A [GitHub Copilot](https://github.com/features/copilot) subscription, or a [Anthropic Claude](https://www.anthropic.com/) or [OpenAI Codex](https://openai.com/api/) API key +- **GitHub Repository** - a GitHub repository you are maintainer on +- **GitHub Actions** enabled in your repository +- **GitHub CLI** (`gh`) - A command-line tool for GitHub. [Install here](https://cli.github.com) v2.0.0+ +- **Operating System**: Linux, macOS, or Windows with WSL ### Step 1 — Install the extension