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
3 changes: 3 additions & 0 deletions docs/workflows/gh-agent-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ Each workflow directory contains an `example.yml` starter and a README for trigg
| [Breaking Change Detect](gh-agent-workflows/breaking-change-detect.md) | Weekday schedule | Detect undocumented public breaking changes |
| [Bug Exterminator](gh-agent-workflows/bug-exterminator.md) | Weekday schedule | Fix bug-hunter issues and open a focused PR |
| [Bug Hunter](gh-agent-workflows/bug-hunter.md) | Weekday schedule | Find reproducible bugs and file reports |
| [CI Doctor](gh-agent-workflows/ci-doctor.md) | Failed `CI` workflow runs + manual dispatch | Diagnose CI failures and file root-cause-first reports |
| [CLI Consistency Checker](gh-agent-workflows/cli-consistency-checker.md) | Weekday schedule | Detect CLI help/output inconsistencies and documentation drift |
| [Code Simplifier](gh-agent-workflows/code-simplifier.md) | Weekday schedule | Simplify overcomplicated code with high-confidence refactors |
| [Docs Drift](gh-agent-workflows/docs-drift.md) | Weekday schedule | Detect code changes needing doc updates |
| [Docs Drift External](gh-agent-workflows/docs-drift-external.md) | Weekday schedule | Detect code changes needing published Elastic doc updates |
Expand All @@ -58,6 +60,7 @@ Each workflow directory contains an `example.yml` starter and a README for trigg
| [Semantic Function Clustering](gh-agent-workflows/semantic-function-clustering.md) | Weekday schedule | Identify function clustering refactor opportunities |
| [Small Problem Fixer](gh-agent-workflows/small-problem-fixer.md) | Weekday schedule | Fix small, related issues and open a focused PR |
| [Stale Issues](gh-agent-workflows/stale-issues.md) | Weekday schedule | Find resolved issues that can be closed |
| [Terminal Stylist](gh-agent-workflows/terminal-stylist.md) | Weekday schedule | Find low-risk user-facing text and terminal UX improvements |
| [Test Improvement](gh-agent-workflows/test-improvement.md) | Weekly schedule | Add targeted tests and clean up redundant coverage |

## Secrets
Expand Down
3 changes: 3 additions & 0 deletions gh-agent-workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ secret manually, `--continuous-improvement` to also install selected continuous
workflows, or `--repo OWNER/REPO` when auto-detection is not available.

`--continuous-improvement` adds:
- `cli-consistency-checker`
- `ci-doctor`
- `bug-hunter`
- `bug-exterminator`
- `code-simplifier`
Expand All @@ -41,4 +43,5 @@ workflows, or `--repo OWNER/REPO` when auto-detection is not available.
- `test-improvement`
- `breaking-change-detect`
- `semantic-function-clustering`
- `terminal-stylist`
- `update-pr-body`
36 changes: 36 additions & 0 deletions gh-agent-workflows/ci-doctor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# CI Doctor

Investigate failed CI runs, identify root causes, and file actionable diagnosis issues.

## How it works

Triggers on failed `CI` workflow runs, inspects failed jobs and logs, checks for recurrence, and files one de-duplicated issue with concrete remediation steps.

## Quick Install

```bash
mkdir -p .github/workflows && curl -sL \
https://raw.githubusercontent.com/elastic/ai-github-actions/v0/gh-agent-workflows/ci-doctor/example.yml \
-o .github/workflows/ci-doctor.yml
```

See [example.yml](example.yml) for the full workflow file.

## Trigger

| Event | Schedule |
| --- | --- |
| `workflow_run` (`CI`) | On completion (job filters to failures) |
| `workflow_dispatch` | Manual |

## Inputs

| Input | Description | Required | Default |
| --- | --- | --- | --- |
| `additional-instructions` | Repo-specific instructions appended to the agent prompt | No | `""` |
| `setup-commands` | Shell commands run before the agent starts | No | `""` |
| `allowed-bot-users` | Allowlisted bot actor usernames (comma-separated) | No | `github-actions[bot]` |

## Safe Outputs

- `create-issue` — file a CI diagnosis report (max 1, auto-closes older reports)
20 changes: 20 additions & 0 deletions gh-agent-workflows/ci-doctor/example.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: CI Doctor
on:
workflow_run:
workflows: ["CI"]
types: [completed]
branches: [main]
workflow_dispatch:

permissions:
actions: read
contents: read
issues: write
pull-requests: read

jobs:
run:
if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'failure' }}
uses: elastic/ai-github-actions/.github/workflows/gh-aw-ci-doctor.lock.yml@v0
secrets:
COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
36 changes: 36 additions & 0 deletions gh-agent-workflows/cli-consistency-checker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# CLI Consistency Checker

Inspect `gh-aw` CLI help surfaces for inconsistencies, typos, and documentation drift.

## How it works

Runs the CLI help entry points, compares wording and command coverage against docs, and files a consolidated issue only when it finds concrete inconsistencies.

## Quick Install

```bash
mkdir -p .github/workflows && curl -sL \
https://raw.githubusercontent.com/elastic/ai-github-actions/v0/gh-agent-workflows/cli-consistency-checker/example.yml \
-o .github/workflows/cli-consistency-checker.yml
```

See [example.yml](example.yml) for the full workflow file.

## Trigger

| Event | Schedule |
| --- | --- |
| `schedule` | Weekdays |
| `workflow_dispatch` | Manual |

## Inputs

| Input | Description | Required | Default |
| --- | --- | --- | --- |
| `additional-instructions` | Repo-specific instructions appended to the agent prompt | No | `""` |
| `setup-commands` | Shell commands run before the agent starts | No | `""` |
| `allowed-bot-users` | Allowlisted bot actor usernames (comma-separated) | No | `github-actions[bot]` |

## Safe Outputs

- `create-issue` — file a CLI consistency report (max 1, auto-closes older reports)
16 changes: 16 additions & 0 deletions gh-agent-workflows/cli-consistency-checker/example.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: CLI Consistency Checker
on:
schedule:
- cron: "0 13 * * 1-5"
workflow_dispatch:

permissions:
contents: read
issues: write
pull-requests: read

jobs:
run:
uses: elastic/ai-github-actions/.github/workflows/gh-aw-cli-consistency-checker.lock.yml@v0
secrets:
COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
36 changes: 36 additions & 0 deletions gh-agent-workflows/terminal-stylist/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Terminal Stylist

Find low-risk text and terminal UX improvements for user-facing CLI output.

## How it works

Scans user-facing output strings, formatting calls, and terminal presentation patterns to find typos, inconsistent wording, and readability improvements, then files a single issue with low-impact fixes.

## Quick Install

```bash
mkdir -p .github/workflows && curl -sL \
https://raw.githubusercontent.com/elastic/ai-github-actions/v0/gh-agent-workflows/terminal-stylist/example.yml \
-o .github/workflows/terminal-stylist.yml
```

See [example.yml](example.yml) for the full workflow file.

## Trigger

| Event | Schedule |
| --- | --- |
| `schedule` | Weekdays |
| `workflow_dispatch` | Manual |

## Inputs

| Input | Description | Required | Default |
| --- | --- | --- | --- |
| `additional-instructions` | Repo-specific instructions appended to the agent prompt | No | `""` |
| `setup-commands` | Shell commands run before the agent starts | No | `""` |
| `allowed-bot-users` | Allowlisted bot actor usernames (comma-separated) | No | `github-actions[bot]` |

## Safe Outputs

- `create-issue` — file a terminal/text quality report (max 1, auto-closes older reports)
16 changes: 16 additions & 0 deletions gh-agent-workflows/terminal-stylist/example.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Terminal Stylist
on:
schedule:
- cron: "0 15 * * 1-5"
workflow_dispatch:

permissions:
contents: read
issues: write
pull-requests: read

jobs:
run:
uses: elastic/ai-github-actions/.github/workflows/gh-aw-terminal-stylist.lock.yml@v0
secrets:
COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ nav:
- Breaking Change Detect: workflows/gh-agent-workflows/breaking-change-detect.md
- Bug Exterminator: workflows/gh-agent-workflows/bug-exterminator.md
- Bug Hunter: workflows/gh-agent-workflows/bug-hunter.md
- CI Doctor: workflows/gh-agent-workflows/ci-doctor.md
- CLI Consistency Checker: workflows/gh-agent-workflows/cli-consistency-checker.md
- Code Simplifier: workflows/gh-agent-workflows/code-simplifier.md
- Docs Drift: workflows/gh-agent-workflows/docs-drift.md
- Docs Drift External: workflows/gh-agent-workflows/docs-drift-external.md
Expand All @@ -43,6 +45,7 @@ nav:
- Semantic Function Clustering: workflows/gh-agent-workflows/semantic-function-clustering.md
- Small Problem Fixer: workflows/gh-agent-workflows/small-problem-fixer.md
- Stale Issues: workflows/gh-agent-workflows/stale-issues.md
- Terminal Stylist: workflows/gh-agent-workflows/terminal-stylist.md
- Test Improvement: workflows/gh-agent-workflows/test-improvement.md
- Legacy:
- Claude Composite Actions: workflows/claude-workflows.md
Expand Down
3 changes: 3 additions & 0 deletions scripts/quick-setup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ default_workflows=(
pr-ci-detective
)
continuous_improvement_workflows=(
cli-consistency-checker
ci-doctor
bug-hunter
bug-exterminator
code-simplifier
Expand All @@ -136,6 +138,7 @@ continuous_improvement_workflows=(
test-improvement
breaking-change-detect
semantic-function-clustering
terminal-stylist
update-pr-body
)

Expand Down
Loading