From 5754586b0b4231d832f9efa18efde807a18a9072 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 21 Feb 2026 03:16:46 +0000 Subject: [PATCH] Add cli-consistency, ci-doctor, and terminal-stylist workflows Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- docs/workflows/gh-agent-workflows.md | 3 ++ gh-agent-workflows/README.md | 3 ++ gh-agent-workflows/ci-doctor/README.md | 36 +++++++++++++++++++ gh-agent-workflows/ci-doctor/example.yml | 20 +++++++++++ .../cli-consistency-checker/README.md | 36 +++++++++++++++++++ .../cli-consistency-checker/example.yml | 16 +++++++++ gh-agent-workflows/terminal-stylist/README.md | 36 +++++++++++++++++++ .../terminal-stylist/example.yml | 16 +++++++++ mkdocs.yml | 3 ++ scripts/quick-setup.sh | 3 ++ 10 files changed, 172 insertions(+) create mode 100644 gh-agent-workflows/ci-doctor/README.md create mode 100644 gh-agent-workflows/ci-doctor/example.yml create mode 100644 gh-agent-workflows/cli-consistency-checker/README.md create mode 100644 gh-agent-workflows/cli-consistency-checker/example.yml create mode 100644 gh-agent-workflows/terminal-stylist/README.md create mode 100644 gh-agent-workflows/terminal-stylist/example.yml diff --git a/docs/workflows/gh-agent-workflows.md b/docs/workflows/gh-agent-workflows.md index f52c24ea..379850dc 100644 --- a/docs/workflows/gh-agent-workflows.md +++ b/docs/workflows/gh-agent-workflows.md @@ -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 | @@ -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 diff --git a/gh-agent-workflows/README.md b/gh-agent-workflows/README.md index d4f7d835..143b1ebd 100644 --- a/gh-agent-workflows/README.md +++ b/gh-agent-workflows/README.md @@ -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` @@ -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` diff --git a/gh-agent-workflows/ci-doctor/README.md b/gh-agent-workflows/ci-doctor/README.md new file mode 100644 index 00000000..7c589d26 --- /dev/null +++ b/gh-agent-workflows/ci-doctor/README.md @@ -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) diff --git a/gh-agent-workflows/ci-doctor/example.yml b/gh-agent-workflows/ci-doctor/example.yml new file mode 100644 index 00000000..3f93e1c0 --- /dev/null +++ b/gh-agent-workflows/ci-doctor/example.yml @@ -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 }} diff --git a/gh-agent-workflows/cli-consistency-checker/README.md b/gh-agent-workflows/cli-consistency-checker/README.md new file mode 100644 index 00000000..aec8841a --- /dev/null +++ b/gh-agent-workflows/cli-consistency-checker/README.md @@ -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) diff --git a/gh-agent-workflows/cli-consistency-checker/example.yml b/gh-agent-workflows/cli-consistency-checker/example.yml new file mode 100644 index 00000000..18c0d8d5 --- /dev/null +++ b/gh-agent-workflows/cli-consistency-checker/example.yml @@ -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 }} diff --git a/gh-agent-workflows/terminal-stylist/README.md b/gh-agent-workflows/terminal-stylist/README.md new file mode 100644 index 00000000..1efaee7d --- /dev/null +++ b/gh-agent-workflows/terminal-stylist/README.md @@ -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) diff --git a/gh-agent-workflows/terminal-stylist/example.yml b/gh-agent-workflows/terminal-stylist/example.yml new file mode 100644 index 00000000..43a19285 --- /dev/null +++ b/gh-agent-workflows/terminal-stylist/example.yml @@ -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 }} diff --git a/mkdocs.yml b/mkdocs.yml index 04c57e87..94f43332 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 @@ -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 diff --git a/scripts/quick-setup.sh b/scripts/quick-setup.sh index e0f6cbcf..c05ed50e 100755 --- a/scripts/quick-setup.sh +++ b/scripts/quick-setup.sh @@ -126,6 +126,8 @@ default_workflows=( pr-ci-detective ) continuous_improvement_workflows=( + cli-consistency-checker + ci-doctor bug-hunter bug-exterminator code-simplifier @@ -136,6 +138,7 @@ continuous_improvement_workflows=( test-improvement breaking-change-detect semantic-function-clustering + terminal-stylist update-pr-body )