Skip to content
Closed
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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` | <Icon name="check-circle" /> | Create tracking issues in central repo |
| `add-comment` | <Icon name="check-circle" /> | Comment on issues in other repos |
| `update-issue` | <Icon name="check-circle" /> | Update issue status across repos |
| `add-labels` | <Icon name="check-circle" /> | Label issues in target repos |
| `create-pull-request` | <Icon name="check-circle" /> | Create PRs in downstream repos |
| `create-discussion` | <Icon name="check-circle" /> | Create discussions in any repo |
| `create-agent-session` | <Icon name="check-circle" /> | Create tasks in target repos |
| `update-release` | <Icon name="check-circle" /> | Update release notes across repos |

**Configuration Example:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -87,7 +89,7 @@ For priority, consider:
- `low-priority`: Nice-to-have improvements, minor enhancements
```

This change takes effect immediately without recompilation.
<Icon name="check-circle" /> This change takes effect immediately without recompilation.

## Editing With Recompilation Required

Expand Down Expand Up @@ -141,7 +143,7 @@ tools:
---
```

⚠️ Run `gh aw compile my-workflow` before committing this change.
<Icon name="alert" /> Run `gh aw compile my-workflow` before committing this change.

## Expressions and Environment Variables

Expand Down Expand Up @@ -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 }}
```

Expand All @@ -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 | <Icon name="x-circle" /> No | GitHub.com or any editor |
| **Output templates** | Change issue format | <Icon name="x-circle" /> No | GitHub.com or any editor |
| **Conditional logic** | "If bug, then..." | <Icon name="x-circle" /> No | GitHub.com or any editor |
| **GitHub expressions** | Add `${{ github.actor }}` | <Icon name="x-circle" /> No | GitHub.com or any editor |
| **Tools** | Add GitHub toolset | <Icon name="check-circle" /> Yes | Local + compile |
| **Permissions** | Add `contents: write` | <Icon name="check-circle" /> Yes | Local + compile |
| **Triggers** | Add `schedule:` | <Icon name="check-circle" /> Yes | Local + compile |
| **Network rules** | Add allowed domain | <Icon name="check-circle" /> Yes | Local + compile |
| **Safe outputs** | Add `create-issue:` | <Icon name="check-circle" /> Yes | Local + compile |
| **Engine** | Change to Claude | <Icon name="check-circle" /> Yes | Local + compile |
| **Imports** | Add shared config | <Icon name="check-circle" /> Yes | Local + compile |

## Related Documentation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar:
order: 2
---

import { Icon } from '@astrojs/starlight/components';

## Adding Workflows

Install workflows from external repositories with optional versioning:
Expand Down Expand Up @@ -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 | <Icon name="x-circle" /> Imported servers override |
| `network:` | Union of allowed domains | <Icon name="check-circle" /> Mode and firewall settings |
| `permissions:` | Validation only | <Icon name="check-circle" /> Main must explicitly declare |
| `safe-outputs:` | Type-level override | <Icon name="check-circle" /> Main overrides imported types |
| `safe-outputs.jobs:` | Conflict detection | Neither (names must be unique) |
| `runtimes:` | Version override | Main versions override |
| `runtimes:` | Version override | <Icon name="check-circle" /> 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 | <Icon name="check-circle" /> Main only (ignored in imports) |

**Example: Tool merging**
```yaml wrap
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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` | <Icon name="check-circle" /> | Create tracking issues in central repo |
| `add-comment` | <Icon name="check-circle" /> | Comment on issues in other repos |
| `update-issue` | <Icon name="check-circle" /> | Update issue status across repos |
| `add-labels` | <Icon name="check-circle" /> | Label issues in target repos |
| `create-pull-request` | <Icon name="check-circle" /> | Create PRs in downstream repos |
| `create-discussion` | <Icon name="check-circle" /> | Create discussions in any repo |
| `create-agent-session` | <Icon name="check-circle" /> | Create tasks in target repos |
| `update-release` | <Icon name="check-circle" /> | Update release notes across repos |

## Teaching Agents Multi-Repo Access

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
## <Icon name="rocket" size="1.5em" /> Most Common Commands

Most users only need these 6 commands:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/setup/creating-workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
111 changes: 0 additions & 111 deletions docs/src/content/docs/setup/quick-start.md

This file was deleted.

13 changes: 7 additions & 6 deletions docs/src/content/docs/setup/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
- <Icon name="check-circle" size="1.2em" /> **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
- <Icon name="check-circle" size="1.2em" /> **GitHub Repository** - a GitHub repository you are maintainer on
- <Icon name="check-circle" size="1.2em" /> **GitHub Actions** enabled in your repository
- <Icon name="check-circle" size="1.2em" /> **GitHub CLI** (`gh`) - A command-line tool for GitHub. [Install here](https://cli.github.com) v2.0.0+
- <Icon name="check-circle" size="1.2em" /> **Operating System**: Linux, macOS, or Windows with WSL

### Step 1 — Install the extension

Expand Down