diff --git a/docs/src/content/docs/agent-factory-status.mdx b/docs/src/content/docs/agent-factory-status.mdx index 0536fb79ba4..5a26013b689 100644 --- a/docs/src/content/docs/agent-factory-status.mdx +++ b/docs/src/content/docs/agent-factory-status.mdx @@ -117,6 +117,7 @@ These are experimental agentic workflows used by the GitHub Next team to learn, | [Schema Consistency Checker](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/schema-consistency-checker.md) | claude | [![Schema Consistency Checker](https://github.com/githubnext/gh-aw/actions/workflows/schema-consistency-checker.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/schema-consistency-checker.lock.yml) | - | - | | [Scout](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/scout.md) | claude | [![Scout](https://github.com/githubnext/gh-aw/actions/workflows/scout.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/scout.lock.yml) | - | `/scout` | | [Secret Scanning Triage](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/secret-scanning-triage.md) | copilot | [![Secret Scanning Triage](https://github.com/githubnext/gh-aw/actions/workflows/secret-scanning-triage.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/secret-scanning-triage.lock.yml) | - | - | +| [Security Alert Burndown](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/security-alert-burndown.campaign.g.md) | claude | [![Security Alert Burndown](https://github.com/githubnext/gh-aw/actions/workflows/security-alert-burndown.campaign.g.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/security-alert-burndown.campaign.g.lock.yml) | `0 * * * *` | - | | [Security Alert Burndown](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/security-alert-burndown.md) | copilot | [![Security Alert Burndown](https://github.com/githubnext/gh-aw/actions/workflows/security-alert-burndown.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/security-alert-burndown.lock.yml) | - | - | | [Security Compliance Campaign](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/security-compliance.md) | copilot | [![Security Compliance Campaign](https://github.com/githubnext/gh-aw/actions/workflows/security-compliance.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/security-compliance.lock.yml) | - | - | | [Security Fix PR](https://github.com/githubnext/gh-aw/blob/main/.github/workflows/security-fix-pr.md) | copilot | [![Security Fix PR](https://github.com/githubnext/gh-aw/actions/workflows/security-fix-pr.lock.yml/badge.svg)](https://github.com/githubnext/gh-aw/actions/workflows/security-fix-pr.lock.yml) | - | - | diff --git a/docs/src/content/docs/reference/engines.md b/docs/src/content/docs/reference/engines.md index 315f7565529..8419236adae 100644 --- a/docs/src/content/docs/reference/engines.md +++ b/docs/src/content/docs/reference/engines.md @@ -76,53 +76,49 @@ Create an Anthropic API key at and add gh aw secrets set ANTHROPIC_API_KEY --value "" ``` -### Quick Example with Claude +### Quick Example: Issue Triage with Claude -Here's a minimal workflow that uses Claude to analyze GitHub issues: +Here's a complete example to get started with Claude: -**File**: `.github/workflows/issue-analyzer.md` +**1. Create `.github/workflows/issue-triage.md`:** -```yaml wrap +```markdown --- engine: claude -on: - issues: - types: [opened] +on: issues permissions: contents: read - issues: read + issues: write safe-outputs: add-comment: --- -# Issue Analysis +# Issue Triage + +Analyze this issue and provide helpful triage suggestions: + +1. Identify the issue type (bug, feature request, question, etc.) +2. Check if the issue has enough information +3. Suggest appropriate labels +4. Provide a helpful response +``` + +**2. Set up your Anthropic API key:** + +```bash +gh aw secrets set ANTHROPIC_API_KEY --value "sk-ant-..." +``` + +**3. Compile and push the workflow:** -Analyze this issue and provide: -1. Summary of the problem -2. Suggested labels -3. Any immediate concerns +```bash +gh aw compile .github/workflows/issue-triage.md +git add .github/workflows/issue-triage.lock.yml +git commit -m "Add Claude-powered issue triage workflow" +git push ``` -**Setup:** - -1. Get your API key from [Anthropic Console](https://console.anthropic.com/api-keys) -2. Set the secret: - ```bash wrap - gh aw secrets set ANTHROPIC_API_KEY --value "" - ``` -3. Compile and run: - ```bash wrap - gh aw compile issue-analyzer.md - git add .github/workflows/issue-analyzer.lock.yml - git commit -m "Add issue analyzer workflow" - git push - ``` - -**What it does:** -- Triggers on new issues -- Claude analyzes the issue content -- Posts a comment with analysis -- Uses same safe-outputs system as all engines +**4. Test it:** Open a new issue in your repository - Claude will automatically analyze and comment! ## OpenAI Codex