Text Beautifier¶

Fix text-auditor issues by opening a focused PR with text improvements.

Workflow source: gh-aw-text-beautifier.md

How it works¶

Picks up open issues filed by the Text Auditor (labeled text-auditor or with [text-auditor] in the title), applies the suggested text fixes, and opens a PR. Only acts on concrete, unambiguous fixes — skips anything requiring design decisions. Most runs end with noop.

Quick Install¶

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

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-pull-request — open a PR with text fixes (max 1)

Pairing¶

This workflow is the read-write companion to Text Auditor. The auditor finds issues; the beautifier fixes them.

Example Workflow¶

name: Text Beautifier
on:
  schedule:
    - cron: "0 14 * * 1-5"
  workflow_dispatch:

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

jobs:
  run:
    uses: elastic/ai-github-actions/.github/workflows/gh-aw-text-beautifier.lock.yml@v0
    secrets:
      COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}