Skip to content
Open
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
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ AI-powered GitHub workflows for Elastic repositories.

Full documentation lives at https://elastic.github.io/ai-github-actions/.

- GitHub Agent Workflows (recommended): https://elastic.github.io/ai-github-actions/workflows/gh-agent-workflows/
- Elastic AI Software Factory (GitHub Agent Workflows, recommended): https://elastic.github.io/ai-github-actions/workflows/gh-agent-workflows/
- Legacy Claude Composite Actions: https://elastic.github.io/ai-github-actions/workflows/claude-workflows/
- Developing: https://elastic.github.io/ai-github-actions/developing/
- Security: https://elastic.github.io/ai-github-actions/security/
Expand All @@ -16,9 +16,14 @@ Full documentation lives at https://elastic.github.io/ai-github-actions/.

## Overview

- GitHub Agent Workflows are the primary/recommended path and provide safe-output guardrails with configurable engines.
- Elastic AI Software Factory (GitHub Agent Workflows) is the primary/recommended path and provides safe-output guardrails with configurable engines.
- Claude Composite Actions remain supported as a legacy option with RO/RWX/RWXP permission variants.

## Top recommended workflows

- Starter repo operations set: `pr-review`, `issue-triage`, `mention-in-issue`, `mention-in-pr`, `pr-actions-detective`
- Continuous improvement set: `bug-hunter`, `bug-exterminator`, `code-simplifier`, `docs-patrol`, `newbie-contributor-patrol`, `small-problem-fixer`, `stale-issues`, `test-improver`, `breaking-change-detector`, `code-duplication-detector`, `update-pr-body`

## Quick setup script

Run from the repository you want to configure (requires `gh` (authenticated via `gh auth login`), `git`, and `curl`):
Expand Down
30 changes: 27 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,44 @@

AI-powered GitHub workflows for Elastic repositories.

## Recommended approach
## Elastic AI Software Factory (recommended)

| Feature | GitHub Agent Workflows |
| --- | --- |
| Engine | Copilot (default) or Claude |
| Install | Copy trigger YAML (recommended) |
| Guardrails | Safe-outputs framework (structured API outputs) |
| Customization | `additional-instructions`, `setup-commands`, or full shim edit |
| Also called | Elastic AI Software Factory |

GitHub Agent Workflows are recommended for all new deployments and ongoing maintenance.
Elastic AI Software Factory (GitHub Agent Workflows) is recommended for all new deployments and ongoing maintenance.

## Top recommended workflows

### Starter repo operations set

- `pr-review`
- `issue-triage`
- `mention-in-issue`
- `mention-in-pr`
- `pr-actions-detective`

### Continuous improvement add-ons

- `bug-hunter` + `bug-exterminator`
- `code-simplifier`
- `docs-patrol`
- `newbie-contributor-patrol`
- `small-problem-fixer`
- `stale-issues`
- `test-improver`
- `breaking-change-detector`
- `code-duplication-detector`
- `update-pr-body`

## Workflows

- [GitHub Agent Workflows](workflows/gh-agent-workflows.md)
- [Elastic AI Software Factory (GitHub Agent Workflows)](workflows/gh-agent-workflows.md)

## Legacy

Expand Down
11 changes: 9 additions & 2 deletions docs/workflows/gh-agent-workflows.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# GitHub Agent Workflows
# Elastic AI Software Factory (GitHub Agent Workflows)

GitHub Agentic Workflows with safe-output guardrails. Engine and model are configurable per workflow, and updates are delivered via the `v0` tag.
Elastic AI Software Factory is built on GitHub Agent Workflows with safe-output guardrails. Engine and model are configurable per workflow, and updates are delivered via the `v0` tag.

## Install (caller-based, recommended)

Expand All @@ -21,6 +21,13 @@ jobs:

Each workflow directory contains an `example.yml` starter and a README for trigger details, inputs, and safe outputs.

## Recommended workflow sets

The quick setup script includes two opinionated sets:

- **Starter repo operations set (default):** `pr-review`, `issue-triage`, `mention-in-issue`, `mention-in-pr`, `pr-actions-detective`
- **Continuous improvement add-ons (`--continuous-improvement`):** `bug-hunter`, `bug-exterminator`, `code-simplifier`, `docs-patrol`, `newbie-contributor-patrol`, `small-problem-fixer`, `stale-issues`, `test-improver`, `breaking-change-detector`, `code-duplication-detector`, `update-pr-body`

## Available workflows

### Base workflows
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ hooks:
nav:
- Home: index.md
- Workflows:
- GitHub Agent Workflows:
- Elastic AI Software Factory (GitHub Agent Workflows):
- Overview: workflows/gh-agent-workflows.md
- Base Workflows:
- Scheduled Audit: workflows/gh-agent-workflows/scheduled-audit.md
Expand Down