diff --git a/.github/aw/create-agentic-workflow.md b/.github/aw/create-agentic-workflow.md index d21d88fb07f..286412873e4 100644 --- a/.github/aw/create-agentic-workflow.md +++ b/.github/aw/create-agentic-workflow.md @@ -313,7 +313,7 @@ These resources contain workflow patterns, best practices, safe outputs, and per - Need to trigger workflows in other repos (use separate workflow in target repo) **Documentation Reference:** - - Full guide: https://github.github.com/gh-aw/patterns/multirepoops/ + - Full guide: https://github.github.com/gh-aw/patterns/multi-repo-ops/ - Safe Outputs Reference: https://github.github.com/gh-aw/reference/safe-outputs/ - GitHub Tools: https://github.github.com/gh-aw/reference/tools/#github-tools-github @@ -668,7 +668,7 @@ When you identify issues requiring tracking: ``` **Reference Documentation:** -- https://github.github.com/gh-aw/patterns/multirepoops/ +- https://github.github.com/gh-aw/patterns/multi-repo-ops/ ### Step 3: Create the Workflow File diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 555dda06547..bda6f4f9338 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -181,20 +181,20 @@ export default defineConfig({ { label: 'Design Patterns', items: [ - { label: 'ChatOps', link: '/patterns/chatops/' }, - { label: 'DailyOps', link: '/patterns/dailyops/' }, - { label: 'DataOps', link: '/patterns/dataops/' }, - { label: 'DispatchOps', link: '/patterns/dispatchops/' }, - { label: 'IssueOps', link: '/patterns/issueops/' }, - { label: 'LabelOps', link: '/patterns/labelops/' }, - { label: 'MultiRepoOps', link: '/patterns/multirepoops/' }, + { label: 'ChatOps', link: '/patterns/chat-ops/' }, + { label: 'DailyOps', link: '/patterns/daily-ops/' }, + { label: 'DataOps', link: '/patterns/data-ops/' }, + { label: 'DispatchOps', link: '/patterns/dispatch-ops/' }, + { label: 'IssueOps', link: '/patterns/issue-ops/' }, + { label: 'LabelOps', link: '/patterns/label-ops/' }, + { label: 'MultiRepoOps', link: '/patterns/multi-repo-ops/' }, { label: 'Monitoring', link: '/patterns/monitoring/' }, { label: 'Orchestration', link: '/patterns/orchestration/' }, - { label: 'ProjectOps', link: '/patterns/projectops/' }, - { label: 'SideRepoOps', link: '/patterns/siderepoops/' }, - { label: 'SpecOps', link: '/patterns/specops/' }, - { label: 'TaskOps', link: '/patterns/taskops/' }, - { label: 'TrialOps', link: '/patterns/trialops/' }, + { label: 'ProjectOps', link: '/patterns/project-ops/' }, + { label: 'SideRepoOps', link: '/patterns/side-repo-ops/' }, + { label: 'SpecOps', link: '/patterns/spec-ops/' }, + { label: 'TaskOps', link: '/patterns/task-ops/' }, + { label: 'TrialOps', link: '/patterns/trial-ops/' }, ], }, { diff --git a/docs/src/content/docs/blog/2026-01-13-meet-the-workflows-continuous-improvement.md b/docs/src/content/docs/blog/2026-01-13-meet-the-workflows-continuous-improvement.md index a949319fceb..d0622b07672 100644 --- a/docs/src/content/docs/blog/2026-01-13-meet-the-workflows-continuous-improvement.md +++ b/docs/src/content/docs/blog/2026-01-13-meet-the-workflows-continuous-improvement.md @@ -41,7 +41,7 @@ This ensures recently updated modules get reviewed first since new features migh For each module, Go Module Usage Expert researches the repository (releases, docs, best practices), analyzes actual usage patterns using Serena, and generates actionable recommendations. It saves summaries under `scratchpad/mods/` and opens GitHub Discussions. -The output of Go Module Usage Expert is a discussion, which is then often "task mined" for actionable tasks using the [TaskOps](https://github.github.com/gh-aw/patterns/taskops/) design pattern. +The output of Go Module Usage Expert is a discussion, which is then often "task mined" for actionable tasks using the [TaskOps](https://github.github.com/gh-aw/patterns/task-ops/) design pattern. Let's take a look at an example of how this works: @@ -60,7 +60,7 @@ Typist looks for untyped usages: `interface{}` or `any` where specific types wou Using grep patterns and Serena's semantic analysis, it discovers type definitions, identifies semantic duplicates, analyzes untyped usage patterns, and generates refactoring recommendations. -Typist also uses the [TaskOps](https://github.github.com/gh-aw/patterns/taskops/) pattern. This means the job of Typist is not to fix code, but to analyze code and recommend possible improvements. +Typist also uses the [TaskOps](https://github.github.com/gh-aw/patterns/task-ops/) pattern. This means the job of Typist is not to fix code, but to analyze code and recommend possible improvements. Let's take a look at an example of this in practice: diff --git a/docs/src/content/docs/blog/2026-01-27-operational-patterns.md b/docs/src/content/docs/blog/2026-01-27-operational-patterns.md index eb1398080be..eaca7c0f333 100644 --- a/docs/src/content/docs/blog/2026-01-27-operational-patterns.md +++ b/docs/src/content/docs/blog/2026-01-27-operational-patterns.md @@ -76,7 +76,7 @@ Here are our tips! - Add help text for `/command help` - Use cache-memory to track command history -**Learn more**: [ChatOps Examples](https://github.github.com/gh-aw/patterns/chatops/) +**Learn more**: [ChatOps Examples](https://github.github.com/gh-aw/patterns/chat-ops/) --- @@ -124,7 +124,7 @@ Here are our tips! - Include progress reports in PR descriptions - Allow human intervention at any phase -**Learn more**: [DailyOps Examples](https://github.github.com/gh-aw/patterns/dailyops/) +**Learn more**: [DailyOps Examples](https://github.github.com/gh-aw/patterns/daily-ops/) --- @@ -175,7 +175,7 @@ Here are our tips! - Update classification rules based on feedback - **For public repos**: Consider if you need to [disable lockdown mode](/gh-aw/reference/faq/#what-is-github-lockdown-mode-and-when-is-it-enabled) to process issues from all users (this is one of the rare safe use cases - see [Lockdown Mode](/gh-aw/reference/lockdown-mode/) for security guidance) -**Learn more**: [IssueOps Examples](https://github.github.com/gh-aw/patterns/issueops/) +**Learn more**: [IssueOps Examples](https://github.github.com/gh-aw/patterns/issue-ops/) --- @@ -224,7 +224,7 @@ Here are our tips! - Avoid label proliferation - Use label descriptions -**Learn more**: [LabelOps Examples](https://github.github.com/gh-aw/patterns/labelops/) +**Learn more**: [LabelOps Examples](https://github.github.com/gh-aw/patterns/label-ops/) --- @@ -274,7 +274,7 @@ Here are our tips! - Allow manual overrides - Track automation accuracy -**Learn more**: [ProjectOps Examples](https://github.github.com/gh-aw/patterns/projectops/) +**Learn more**: [ProjectOps Examples](https://github.github.com/gh-aw/patterns/project-ops/) --- @@ -337,7 +337,7 @@ Here are our tips! - Include acceptance criteria - Review and iterate -**Learn more**: [TaskOps](https://github.github.com/gh-aw/patterns/taskops/) +**Learn more**: [TaskOps](https://github.github.com/gh-aw/patterns/task-ops/) --- @@ -388,7 +388,7 @@ Here are our tips! - Batch operations efficiently - Monitor cross-repo dependencies -**Learn more**: [MultiRepoOps](https://github.github.com/gh-aw/patterns/multirepoops/) +**Learn more**: [MultiRepoOps](https://github.github.com/gh-aw/patterns/multi-repo-ops/) --- @@ -427,7 +427,7 @@ Here are our tips! - Set up appropriate notifications - Plan for eventual migration if successful -**Learn more**: [SideRepoOps](https://github.github.com/gh-aw/patterns/siderepoops/) +**Learn more**: [SideRepoOps](https://github.github.com/gh-aw/patterns/side-repo-ops/) --- @@ -452,7 +452,7 @@ These workflows do the following: 5. Capture and validate outputs 6. Delete trial repo or keep for reference -**Learn more**: [TrialOps](https://github.github.com/gh-aw/patterns/trialops/) +**Learn more**: [TrialOps](https://github.github.com/gh-aw/patterns/trial-ops/) --- diff --git a/docs/src/content/docs/examples/comment-triggered.md b/docs/src/content/docs/examples/comment-triggered.md index 21887c8b9d0..e2452ebcbf1 100644 --- a/docs/src/content/docs/examples/comment-triggered.md +++ b/docs/src/content/docs/examples/comment-triggered.md @@ -16,7 +16,7 @@ Comment-triggered workflows respond to slash commands typed in GitHub conversati ## Patterns in This Section -- **[ChatOps](/gh-aw/patterns/chatops/)** - Build interactive automation with command triggers +- **[ChatOps](/gh-aw/patterns/chat-ops/)** - Build interactive automation with command triggers ## Example Command Triggers diff --git a/docs/src/content/docs/examples/issue-pr-events.md b/docs/src/content/docs/examples/issue-pr-events.md index 5a04d95fcee..887a84c5602 100644 --- a/docs/src/content/docs/examples/issue-pr-events.md +++ b/docs/src/content/docs/examples/issue-pr-events.md @@ -16,9 +16,9 @@ Issue and PR event workflows run automatically when specific GitHub events occur ## Patterns in This Section -- **[IssueOps](/gh-aw/patterns/issueops/)** - Automate issue triage and management -- **[LabelOps](/gh-aw/patterns/labelops/)** - Use labels as workflow triggers -- **[ProjectOps](/gh-aw/patterns/projectops/)** - Automate project board management +- **[IssueOps](/gh-aw/patterns/issue-ops/)** - Automate issue triage and management +- **[LabelOps](/gh-aw/patterns/label-ops/)** - Use labels as workflow triggers +- **[ProjectOps](/gh-aw/patterns/project-ops/)** - Automate project board management - **[Triage & Analysis](/gh-aw/examples/issue-pr-events/triage-analysis/)** - Intelligent triage and problem investigation - **[Coding & Development](/gh-aw/examples/issue-pr-events/coding-development/)** - PR assistance and code improvements - **[Quality & Testing](/gh-aw/examples/issue-pr-events/quality-testing/)** - Automated quality checks diff --git a/docs/src/content/docs/examples/multi-repo.md b/docs/src/content/docs/examples/multi-repo.md index 531294a7016..0fc31b78c38 100644 --- a/docs/src/content/docs/examples/multi-repo.md +++ b/docs/src/content/docs/examples/multi-repo.md @@ -153,7 +153,7 @@ For organization-wide workflows, use organization-level secrets, configure GitHu For comprehensive documentation on the MultiRepoOps design pattern, see: -[MultiRepoOps Design Pattern](/gh-aw/patterns/multirepoops/) +[MultiRepoOps Design Pattern](/gh-aw/patterns/multi-repo-ops/) ## Related Documentation diff --git a/docs/src/content/docs/examples/multi-repo/feature-sync.md b/docs/src/content/docs/examples/multi-repo/feature-sync.md index bdcd6e67e96..d176f50744f 100644 --- a/docs/src/content/docs/examples/multi-repo/feature-sync.md +++ b/docs/src/content/docs/examples/multi-repo/feature-sync.md @@ -269,7 +269,7 @@ For enhanced security, use GitHub App installation tokens. See [GitHub App for S ## Related Documentation -- [MultiRepoOps Design Pattern](/gh-aw/patterns/multirepoops/) - Complete multi-repo overview +- [MultiRepoOps Design Pattern](/gh-aw/patterns/multi-repo-ops/) - Complete multi-repo overview - [Cross-Repo Issue Tracking](/gh-aw/examples/multi-repo/issue-tracking/) - Issue management patterns - [Safe Outputs Reference](/gh-aw/reference/safe-outputs/) - Pull request configuration - [GitHub Tools](/gh-aw/reference/tools/#github-tools-github) - Repository access tools diff --git a/docs/src/content/docs/examples/multi-repo/issue-tracking.md b/docs/src/content/docs/examples/multi-repo/issue-tracking.md index 6e51d3c46cf..8f2ccfb3ced 100644 --- a/docs/src/content/docs/examples/multi-repo/issue-tracking.md +++ b/docs/src/content/docs/examples/multi-repo/issue-tracking.md @@ -298,7 +298,7 @@ For enhanced security, use GitHub App installation tokens. See [GitHub App for S ## Related Documentation -- [MultiRepoOps Design Pattern](/gh-aw/patterns/multirepoops/) - Complete multi-repo overview +- [MultiRepoOps Design Pattern](/gh-aw/patterns/multi-repo-ops/) - Complete multi-repo overview - [Feature Synchronization](/gh-aw/examples/multi-repo/feature-sync/) - Code sync patterns - [Safe Outputs Reference](/gh-aw/reference/safe-outputs/) - Issue creation configuration - [GitHub Tools](/gh-aw/reference/tools/#github-tools-github) - API access configuration diff --git a/docs/src/content/docs/examples/scheduled.md b/docs/src/content/docs/examples/scheduled.md index 5768e7c715c..16b528a1aa3 100644 --- a/docs/src/content/docs/examples/scheduled.md +++ b/docs/src/content/docs/examples/scheduled.md @@ -16,7 +16,7 @@ Scheduled workflows run automatically at specified times using cron expressions. ## Patterns in This Section -- **[DailyOps](/gh-aw/patterns/dailyops/)** - Make incremental improvements through small daily changes +- **[DailyOps](/gh-aw/patterns/daily-ops/)** - Make incremental improvements through small daily changes - **[Research & Planning](/gh-aw/examples/scheduled/research-planning/)** - Automated research, status reports, and planning ## Example Schedule Triggers diff --git a/docs/src/content/docs/guides/ephemerals.md b/docs/src/content/docs/guides/ephemerals.md index 36c2c5e3a16..83ef8d9b2b4 100644 --- a/docs/src/content/docs/guides/ephemerals.md +++ b/docs/src/content/docs/guides/ephemerals.md @@ -170,7 +170,7 @@ See [Safe Outputs Reference](/gh-aw/reference/safe-outputs/#hide-older-comments) Run agentic workflows from a separate "side" repository that targets your main codebase. This isolates AI-generated issues, comments, and workflow runs from your main repository, keeping automation infrastructure separate from production code. -See [SideRepoOps](/gh-aw/patterns/siderepoops/) for complete setup and usage documentation. +See [SideRepoOps](/gh-aw/patterns/side-repo-ops/) for complete setup and usage documentation. ### Text Sanitization @@ -237,6 +237,6 @@ This configuration ensures: - [Triggers Reference](/gh-aw/reference/triggers/) - Complete trigger configuration including `stop-after` - [Safe Outputs Reference](/gh-aw/reference/safe-outputs/) - All safe output types and expiration options -- [SideRepoOps](/gh-aw/patterns/siderepoops/) - Complete setup for side repository operations +- [SideRepoOps](/gh-aw/patterns/side-repo-ops/) - Complete setup for side repository operations - [Authentication](/gh-aw/reference/auth/) - Authentication and security considerations - [Orchestration](/gh-aw/patterns/orchestration/) - Orchestrating multi-workflow initiatives diff --git a/docs/src/content/docs/patterns/centralrepoops.mdx b/docs/src/content/docs/patterns/central-repo-ops.mdx similarity index 96% rename from docs/src/content/docs/patterns/centralrepoops.mdx rename to docs/src/content/docs/patterns/central-repo-ops.mdx index b30f7432032..52c61ac76d4 100644 --- a/docs/src/content/docs/patterns/centralrepoops.mdx +++ b/docs/src/content/docs/patterns/central-repo-ops.mdx @@ -6,7 +6,7 @@ description: Operate and roll out changes across many repositories from a single > [!WARNING] > **Experimental:** CentralRepoOps is still experimental! Things may break, change, or be removed without deprecation at any time. -CentralRepoOps is a [MultiRepoOps](/gh-aw/patterns/multirepoops/) deployment variant where a single private repository acts as a control plane for large-scale operations across many repositories. +CentralRepoOps is a [MultiRepoOps](/gh-aw/patterns/multi-repo-ops/) deployment variant where a single private repository acts as a control plane for large-scale operations across many repositories. Use this pattern when you need to coordinate rollouts, policy updates, and tracking across tens or hundreds of repositories from a private central location, using cross-repository safe outputs and secure authentication to deliver consistency, control, and auditability. @@ -266,6 +266,6 @@ After the setup is complete, you can run the orchestrator with `workflow_dispatc ## Related Patterns -- **[MultiRepoOps](/gh-aw/patterns/multirepoops/)** - Cross-repository automation capability +- **[MultiRepoOps](/gh-aw/patterns/multi-repo-ops/)** - Cross-repository automation capability - **[Orchestration](/gh-aw/patterns/orchestration/)** - Generic orchestrator/worker dispatch pattern -- **[SideRepoOps](/gh-aw/patterns/siderepoops/)** - Isolated control-plane setup +- **[SideRepoOps](/gh-aw/patterns/side-repo-ops/)** - Isolated control-plane setup diff --git a/docs/src/content/docs/patterns/chatops.md b/docs/src/content/docs/patterns/chat-ops.md similarity index 100% rename from docs/src/content/docs/patterns/chatops.md rename to docs/src/content/docs/patterns/chat-ops.md diff --git a/docs/src/content/docs/patterns/dailyops.md b/docs/src/content/docs/patterns/daily-ops.md similarity index 100% rename from docs/src/content/docs/patterns/dailyops.md rename to docs/src/content/docs/patterns/daily-ops.md diff --git a/docs/src/content/docs/patterns/dataops.md b/docs/src/content/docs/patterns/data-ops.md similarity index 98% rename from docs/src/content/docs/patterns/dataops.md rename to docs/src/content/docs/patterns/data-ops.md index a7a532f1adb..aad149df1e2 100644 --- a/docs/src/content/docs/patterns/dataops.md +++ b/docs/src/content/docs/patterns/data-ops.md @@ -246,4 +246,4 @@ Analyze the combined data at `/tmp/gh-aw/combined.json` covering: - [Steps Reference](/gh-aw/reference/frontmatter/#custom-steps-steps) - Shell step configuration - [Safe Outputs Reference](/gh-aw/reference/safe-outputs/) - Validated GitHub operations - [Cache Memory](/gh-aw/reference/cache-memory/) - Caching data between runs -- [DailyOps](/gh-aw/patterns/dailyops/) - Scheduled improvement workflows +- [DailyOps](/gh-aw/patterns/daily-ops/) - Scheduled improvement workflows diff --git a/docs/src/content/docs/patterns/dispatchops.md b/docs/src/content/docs/patterns/dispatch-ops.md similarity index 98% rename from docs/src/content/docs/patterns/dispatchops.md rename to docs/src/content/docs/patterns/dispatch-ops.md index c6d79f1fd8a..f8ea5687e07 100644 --- a/docs/src/content/docs/patterns/dispatchops.md +++ b/docs/src/content/docs/patterns/dispatch-ops.md @@ -333,7 +333,7 @@ gh aw run research --ref feature/improve-workflow gh pr create --title "Improve workflow" ``` -The workflow runs with your branch's code and state. Safe outputs (issues, PRs, comments) are created in your branch context. Use [trial mode](/gh-aw/patterns/trialops/) for completely isolated testing without affecting the production repository. +The workflow runs with your branch's code and state. Safe outputs (issues, PRs, comments) are created in your branch context. Use [trial mode](/gh-aw/patterns/trial-ops/) for completely isolated testing without affecting the production repository. ## Common Use Cases @@ -363,7 +363,7 @@ The workflow runs with your branch's code and state. Safe outputs (issues, PRs, - [Manual Workflows Example](/gh-aw/examples/manual/) - Example manual workflows - [Triggers Reference](/gh-aw/reference/triggers/) - Complete trigger syntax including workflow_dispatch -- [TrialOps](/gh-aw/patterns/trialops/) - Testing workflows in isolation +- [TrialOps](/gh-aw/patterns/trial-ops/) - Testing workflows in isolation - [CLI Commands](/gh-aw/setup/cli/) - Complete gh aw run command reference - [Templating](/gh-aw/reference/templating/) - Using expressions and conditionals - [Security Best Practices](/gh-aw/introduction/architecture/) - Securing workflow execution diff --git a/docs/src/content/docs/patterns/issueops.md b/docs/src/content/docs/patterns/issue-ops.md similarity index 100% rename from docs/src/content/docs/patterns/issueops.md rename to docs/src/content/docs/patterns/issue-ops.md diff --git a/docs/src/content/docs/patterns/labelops.md b/docs/src/content/docs/patterns/label-ops.md similarity index 98% rename from docs/src/content/docs/patterns/labelops.md rename to docs/src/content/docs/patterns/label-ops.md index 8e840f76726..4672f65a782 100644 --- a/docs/src/content/docs/patterns/labelops.md +++ b/docs/src/content/docs/patterns/label-ops.md @@ -75,6 +75,6 @@ Address label explosion with AI-powered periodic audits for consolidation. Preve ## Additional Resources - [Trigger Events](/gh-aw/reference/triggers/) - Complete trigger configuration including label filtering -- [IssueOps](/gh-aw/patterns/issueops/) - Learn about issue-triggered workflows +- [IssueOps](/gh-aw/patterns/issue-ops/) - Learn about issue-triggered workflows - [Safe Outputs Reference](/gh-aw/reference/safe-outputs/) - Secure output handling - [Frontmatter Reference](/gh-aw/reference/frontmatter/) - Complete workflow configuration options diff --git a/docs/src/content/docs/patterns/multirepoops.md b/docs/src/content/docs/patterns/multi-repo-ops.md similarity index 98% rename from docs/src/content/docs/patterns/multirepoops.md rename to docs/src/content/docs/patterns/multi-repo-ops.md index 8b8977b5ada..80eac71c2d9 100644 --- a/docs/src/content/docs/patterns/multirepoops.md +++ b/docs/src/content/docs/patterns/multi-repo-ops.md @@ -250,8 +250,8 @@ For organization-wide workflows: ## Related Patterns -- **[IssueOps](/gh-aw/patterns/issueops/)** - Single-repo issue automation -- **[ChatOps](/gh-aw/patterns/chatops/)** - Command-driven workflows +- **[IssueOps](/gh-aw/patterns/issue-ops/)** - Single-repo issue automation +- **[ChatOps](/gh-aw/patterns/chat-ops/)** - Command-driven workflows - **[Orchestration](/gh-aw/patterns/orchestration/)** - Multi-issue initiative coordination ## Related Documentation diff --git a/docs/src/content/docs/patterns/projectops.md b/docs/src/content/docs/patterns/project-ops.md similarity index 98% rename from docs/src/content/docs/patterns/projectops.md rename to docs/src/content/docs/patterns/project-ops.md index 422f58860dc..9e42ebb5d3f 100644 --- a/docs/src/content/docs/patterns/projectops.md +++ b/docs/src/content/docs/patterns/project-ops.md @@ -154,5 +154,5 @@ ProjectOps complements [GitHub's built-in Projects automation](https://docs.gith - [Projects & Monitoring](/gh-aw/patterns/monitoring/) - Design pattern guide - [Orchestration](/gh-aw/patterns/orchestration/) - Design pattern guide - [Trigger Events](/gh-aw/reference/triggers/) - Event trigger configuration options -- [IssueOps](/gh-aw/patterns/issueops/) - Related issue automation patterns +- [IssueOps](/gh-aw/patterns/issue-ops/) - Related issue automation patterns - [Token Reference](/gh-aw/reference/auth/#gh_aw_project_github_token) - GitHub Projects token setup diff --git a/docs/src/content/docs/patterns/siderepoops.mdx b/docs/src/content/docs/patterns/side-repo-ops.mdx similarity index 95% rename from docs/src/content/docs/patterns/siderepoops.mdx rename to docs/src/content/docs/patterns/side-repo-ops.mdx index 06325fe584a..8b8b391d825 100644 --- a/docs/src/content/docs/patterns/siderepoops.mdx +++ b/docs/src/content/docs/patterns/side-repo-ops.mdx @@ -24,7 +24,7 @@ Use SideRepoOps for workflow experimentation, creating a centralized automation ## How It Differs from MultiRepoOps -While [MultiRepoOps](/gh-aw/patterns/multirepoops/) runs workflows **from** your main repository that create resources **in** other repositories, SideRepoOps inverts this pattern: +While [MultiRepoOps](/gh-aw/patterns/multi-repo-ops/) runs workflows **from** your main repository that create resources **in** other repositories, SideRepoOps inverts this pattern: | Pattern | Workflow Location | Target Repository | Use Case | |---------|------------------|-------------------|----------| @@ -48,7 +48,7 @@ In SideRepoOps, workflows run in GitHub Actions **on the side repository** but p > [!TIP] > Testing with TrialOps -> Before deploying SideRepoOps workflows to production, use [TrialOps](/gh-aw/patterns/trialops/) to test them in isolated trial repositories. This lets you validate behavior and iterate on prompts without creating real issues in your repositories. +> Before deploying SideRepoOps workflows to production, use [TrialOps](/gh-aw/patterns/trial-ops/) to test them in isolated trial repositories. This lets you validate behavior and iterate on prompts without creating real issues in your repositories. ## Setup Requirements @@ -394,9 +394,9 @@ This creates a feedback loop where the side repository tracks automation effecti ## Related Patterns -- **[MultiRepoOps](/gh-aw/patterns/multirepoops/)** - Coordinate work across multiple repositories from main repo +- **[MultiRepoOps](/gh-aw/patterns/multi-repo-ops/)** - Coordinate work across multiple repositories from main repo - **[Orchestration](/gh-aw/patterns/orchestration/)** - Orchestrate multi-issue initiatives -- **[IssueOps](/gh-aw/patterns/issueops/)** - Issue-driven automation patterns +- **[IssueOps](/gh-aw/patterns/issue-ops/)** - Issue-driven automation patterns ## Related Documentation diff --git a/docs/src/content/docs/patterns/specops.md b/docs/src/content/docs/patterns/spec-ops.md similarity index 98% rename from docs/src/content/docs/patterns/specops.md rename to docs/src/content/docs/patterns/spec-ops.md index d4e2eb35348..c7bb293aee7 100644 --- a/docs/src/content/docs/patterns/specops.md +++ b/docs/src/content/docs/patterns/spec-ops.md @@ -164,7 +164,7 @@ The [MCP Gateway Specification](/gh-aw/reference/mcp-gateway/) demonstrates Spec ## Related Patterns -- **[MultiRepoOps](/gh-aw/patterns/multirepoops/)** - Cross-repository coordination +- **[MultiRepoOps](/gh-aw/patterns/multi-repo-ops/)** - Cross-repository coordination ## References diff --git a/docs/src/content/docs/patterns/taskops.md b/docs/src/content/docs/patterns/task-ops.md similarity index 100% rename from docs/src/content/docs/patterns/taskops.md rename to docs/src/content/docs/patterns/task-ops.md diff --git a/docs/src/content/docs/patterns/trialops.md b/docs/src/content/docs/patterns/trial-ops.md similarity index 95% rename from docs/src/content/docs/patterns/trialops.md rename to docs/src/content/docs/patterns/trial-ops.md index 6fc18988ea8..61fd79b5978 100644 --- a/docs/src/content/docs/patterns/trialops.md +++ b/docs/src/content/docs/patterns/trial-ops.md @@ -7,7 +7,7 @@ sidebar: > [!NOTE] > Part of SideRepoOps -> TrialOps is a specialized testing pattern that extends [SideRepoOps](/gh-aw/patterns/siderepoops/). While SideRepoOps runs workflows from a separate repository against your main codebase, TrialOps uses temporary trial repositories to safely validate and test workflows before production deployment. +> TrialOps is a specialized testing pattern that extends [SideRepoOps](/gh-aw/patterns/side-repo-ops/). While SideRepoOps runs workflows from a separate repository against your main codebase, TrialOps uses temporary trial repositories to safely validate and test workflows before production deployment. TrialOps runs agentic workflows in isolated trial repositories to safely validate behavior, compare approaches, and iterate on prompts without affecting production. The `trial` command creates temporary private repositories where workflows execute and capture safe outputs (issues, PRs, comments) without modifying your actual codebase. @@ -285,8 +285,8 @@ gh aw trial ./workflow.md --clone-repo myorg/production --trigger-context "https ## Related Documentation -- [SideRepoOps](/gh-aw/patterns/siderepoops/) - Run workflows from separate repositories -- [MultiRepoOps](/gh-aw/patterns/multirepoops/) - Coordinate across multiple repositories +- [SideRepoOps](/gh-aw/patterns/side-repo-ops/) - Run workflows from separate repositories +- [MultiRepoOps](/gh-aw/patterns/multi-repo-ops/) - Coordinate across multiple repositories - [Orchestration](/gh-aw/patterns/orchestration/) - Orchestrate multi-issue initiatives - [CLI Commands](/gh-aw/setup/cli/) - Complete CLI reference - [Safe Outputs Reference](/gh-aw/reference/safe-outputs/) - Configuration options diff --git a/docs/src/content/docs/reference/faq.md b/docs/src/content/docs/reference/faq.md index 3d8d579852d..1954f067dd5 100644 --- a/docs/src/content/docs/reference/faq.md +++ b/docs/src/content/docs/reference/faq.md @@ -51,11 +51,11 @@ Not by default, but yes with proper configuration. Cross-repository access requi 1. A **Personal Access Token (PAT)** with access to target repositories 2. Configuring the token in your workflow -See [MultiRepoOps](/gh-aw/patterns/multirepoops/) for coordinating across repositories, or [SideRepoOps](/gh-aw/patterns/siderepoops/) for running workflows from a separate repository. +See [MultiRepoOps](/gh-aw/patterns/multi-repo-ops/) for coordinating across repositories, or [SideRepoOps](/gh-aw/patterns/side-repo-ops/) for running workflows from a separate repository. ### Can I use agentic workflows in private repositories? -Yes, and in many cases we recommend it. Private repositories are ideal for proprietary code, creating a "sidecar" repository with limited access, testing workflows, and organization-internal automation. See [SideRepoOps](/gh-aw/patterns/siderepoops/) for patterns using private repositories. +Yes, and in many cases we recommend it. Private repositories are ideal for proprietary code, creating a "sidecar" repository with limited access, testing workflows, and organization-internal automation. See [SideRepoOps](/gh-aw/patterns/side-repo-ops/) for patterns using private repositories. ### Can I edit workflows directly on GitHub.com without recompiling? @@ -224,7 +224,7 @@ If you want to use a coding agent that isn't currently supported (Copilot, Claud ### Can I test workflows without affecting my repository? -Yes! Use [TrialOps](/gh-aw/patterns/trialops/) to test workflows in isolated trial repositories. This lets you validate behavior and iterate on prompts without creating real issues, PRs, or comments in your actual repository. +Yes! Use [TrialOps](/gh-aw/patterns/trial-ops/) to test workflows in isolated trial repositories. This lets you validate behavior and iterate on prompts without creating real issues, PRs, or comments in your actual repository. ### Where can I find help with common issues? diff --git a/docs/src/content/docs/reference/glossary.md b/docs/src/content/docs/reference/glossary.md index 86615e96825..055b19847c6 100644 --- a/docs/src/content/docs/reference/glossary.md +++ b/docs/src/content/docs/reference/glossary.md @@ -255,27 +255,27 @@ Operational patterns (suffixed with "-Ops") are established workflow architectur ### ChatOps -Interactive automation triggered by slash commands (`/review`, `/deploy`) in issues and pull requests, enabling human-in-the-loop automation where developers invoke AI assistance on demand. See [ChatOps](/gh-aw/patterns/chatops/). +Interactive automation triggered by slash commands (`/review`, `/deploy`) in issues and pull requests, enabling human-in-the-loop automation where developers invoke AI assistance on demand. See [ChatOps](/gh-aw/patterns/chat-ops/). ### DailyOps -Scheduled workflows for incremental daily improvements, automating progress toward large goals through small, manageable changes on weekday schedules. See [DailyOps](/gh-aw/patterns/dailyops/). +Scheduled workflows for incremental daily improvements, automating progress toward large goals through small, manageable changes on weekday schedules. See [DailyOps](/gh-aw/patterns/daily-ops/). ### DataOps -Hybrid pattern combining deterministic data extraction in `steps:` with agentic analysis in the workflow body. Shell commands fetch and structure data, then the AI agent interprets results and produces insights. See [DataOps](/gh-aw/patterns/dataops/). +Hybrid pattern combining deterministic data extraction in `steps:` with agentic analysis in the workflow body. Shell commands fetch and structure data, then the AI agent interprets results and produces insights. See [DataOps](/gh-aw/patterns/data-ops/). ### DispatchOps -Manual workflow execution via GitHub Actions UI or CLI using `workflow_dispatch` trigger. Enables on-demand tasks, testing, and workflows requiring human judgment about timing. Workflows can accept custom input parameters. See [DispatchOps](/gh-aw/patterns/dispatchops/). +Manual workflow execution via GitHub Actions UI or CLI using `workflow_dispatch` trigger. Enables on-demand tasks, testing, and workflows requiring human judgment about timing. Workflows can accept custom input parameters. See [DispatchOps](/gh-aw/patterns/dispatch-ops/). ### IssueOps -Automated issue management that analyzes, categorizes, and responds to issues when created. Uses issue event triggers with safe outputs for secure automated triage without requiring write permissions for the AI job. See [IssueOps Examples](/gh-aw/patterns/issueops/). +Automated issue management that analyzes, categorizes, and responds to issues when created. Uses issue event triggers with safe outputs for secure automated triage without requiring write permissions for the AI job. See [IssueOps Examples](/gh-aw/patterns/issue-ops/). ### LabelOps -Workflows triggered by label changes on issues and pull requests. Uses labels as triggers, metadata, and state markers with filtering for specific label additions or removals. See [LabelOps Examples](/gh-aw/patterns/labelops/). +Workflows triggered by label changes on issues and pull requests. Uses labels as triggers, metadata, and state markers with filtering for specific label additions or removals. See [LabelOps Examples](/gh-aw/patterns/label-ops/). ### MemoryOps @@ -283,27 +283,27 @@ Stateful workflows that persist data between runs using `cache-memory` and `repo ### MultiRepoOps -Cross-repository coordination extending automation patterns across multiple repositories. Uses secure authentication and cross-repository safe outputs to synchronize features, centralize tracking, and enforce organization-wide policies. See [MultiRepoOps](/gh-aw/patterns/multirepoops/). +Cross-repository coordination extending automation patterns across multiple repositories. Uses secure authentication and cross-repository safe outputs to synchronize features, centralize tracking, and enforce organization-wide policies. See [MultiRepoOps](/gh-aw/patterns/multi-repo-ops/). ### ProjectOps -AI-powered GitHub Projects board management automating issue triage, routing, and field updates. Analyzes issue/PR content to make intelligent decisions about project assignment, status, priority, and custom fields using the `update-project` safe output. See [ProjectOps](/gh-aw/patterns/projectops/). +AI-powered GitHub Projects board management automating issue triage, routing, and field updates. Analyzes issue/PR content to make intelligent decisions about project assignment, status, priority, and custom fields using the `update-project` safe output. See [ProjectOps](/gh-aw/patterns/project-ops/). ### SideRepoOps -Development pattern where workflows run from a separate "side" repository targeting your main codebase. Keeps AI-generated issues, comments, and workflow runs isolated from the main repository for cleaner separation between automation infrastructure and production code. See [SideRepoOps](/gh-aw/patterns/siderepoops/). +Development pattern where workflows run from a separate "side" repository targeting your main codebase. Keeps AI-generated issues, comments, and workflow runs isolated from the main repository for cleaner separation between automation infrastructure and production code. See [SideRepoOps](/gh-aw/patterns/side-repo-ops/). ### SpecOps -Maintaining and propagating W3C-style specifications using the `w3c-specification-writer` agent. Creates formal specifications with RFC 2119 keywords and automatically synchronizes changes to consuming implementations. See [SpecOps](/gh-aw/patterns/specops/). +Maintaining and propagating W3C-style specifications using the `w3c-specification-writer` agent. Creates formal specifications with RFC 2119 keywords and automatically synchronizes changes to consuming implementations. See [SpecOps](/gh-aw/patterns/spec-ops/). ### TaskOps -Scaffolded AI-powered code improvement strategy with three phases: research agent investigates, developer reviews and invokes planner agent to create actionable issues, then assigns approved issues to Copilot for automated implementation. Keeps developers in control with clear decision points. See [TaskOps](/gh-aw/patterns/taskops/). +Scaffolded AI-powered code improvement strategy with three phases: research agent investigates, developer reviews and invokes planner agent to create actionable issues, then assigns approved issues to Copilot for automated implementation. Keeps developers in control with clear decision points. See [TaskOps](/gh-aw/patterns/task-ops/). ### TrialOps -Testing and validation pattern executing workflows in isolated trial repositories before production deployment. Creates temporary private repositories where workflows run safely, capturing safe outputs without modifying your actual codebase. See [TrialOps](/gh-aw/patterns/trialops/). +Testing and validation pattern executing workflows in isolated trial repositories before production deployment. Creates temporary private repositories where workflows run safely, capturing safe outputs without modifying your actual codebase. See [TrialOps](/gh-aw/patterns/trial-ops/). ## Related Resources diff --git a/docs/src/content/docs/reference/safe-outputs.md b/docs/src/content/docs/reference/safe-outputs.md index e457ef13c47..6cb16816ada 100644 --- a/docs/src/content/docs/reference/safe-outputs.md +++ b/docs/src/content/docs/reference/safe-outputs.md @@ -1224,7 +1224,7 @@ safe-outputs: **Domain Filtering** (`allowed-domains`): Controls which domains are allowed in URLs. URLs from other domains are replaced with `(redacted)`. -**Reference Escaping** (`allowed-github-references`): Controls which GitHub repository references (`#123`, `owner/repo#456`) are allowed in workflow output. When configured, references to unlisted repositories are escaped with backticks to prevent GitHub from creating timeline items. This is particularly useful for [SideRepoOps](/gh-aw/patterns/siderepoops/) workflows to prevent automation from cluttering your main repository's timeline. +**Reference Escaping** (`allowed-github-references`): Controls which GitHub repository references (`#123`, `owner/repo#456`) are allowed in workflow output. When configured, references to unlisted repositories are escaped with backticks to prevent GitHub from creating timeline items. This is particularly useful for [SideRepoOps](/gh-aw/patterns/side-repo-ops/) workflows to prevent automation from cluttering your main repository's timeline. - `[]` - Escape all references (prevents all timeline items) - `["repo"]` - Allow only the target repository's references diff --git a/docs/src/content/docs/reference/triggers.md b/docs/src/content/docs/reference/triggers.md index 644149111db..7cf8f31355d 100644 --- a/docs/src/content/docs/reference/triggers.md +++ b/docs/src/content/docs/reference/triggers.md @@ -429,7 +429,7 @@ on: issue labeled bug, enhancement, priority-high # Multiple labels on: pull_request labeled needs-review, ready-to-merge ``` -All shorthand formats compile to standard GitHub Actions syntax and automatically include the `workflow_dispatch` trigger. Supported for `issue`, `pull_request`, and `discussion` events. See [LabelOps workflows](/gh-aw/patterns/labelops/) for automation examples. +All shorthand formats compile to standard GitHub Actions syntax and automatically include the `workflow_dispatch` trigger. Supported for `issue`, `pull_request`, and `discussion` events. See [LabelOps workflows](/gh-aw/patterns/label-ops/) for automation examples. ### Reactions (`reaction:`) @@ -513,5 +513,5 @@ A pre-activation check runs the search query against the current repository. If - [Schedule Syntax](/gh-aw/reference/schedule-syntax/) - Complete schedule format reference - [Command Triggers](/gh-aw/reference/command-triggers/) - Special @mention triggers and context text - [Frontmatter](/gh-aw/reference/frontmatter/) - Complete frontmatter configuration -- [LabelOps](/gh-aw/patterns/labelops/) - Label-based automation workflows +- [LabelOps](/gh-aw/patterns/label-ops/) - Label-based automation workflows - [Workflow Structure](/gh-aw/reference/workflow-structure/) - Directory layout and organization