Skip to content

[text-auditor] Fix three concrete user-facing text defects (stale workflow name, typo, and misleading log extractor wording) #749

Closed as not planned

Description

@github-actions

Text Improvements

The following user-facing text issues were found in the repository. Each is a low-effort fix.

1. Stale workflow name in setup command points to a non-existent path

File: docs/index.md (lines 112-113)
Current text:

  • curl -fsSL https://raw.githubusercontent.com/elastic/ai-github-actions/v0/gh-agent-workflows/code-simplifier/example.yml \
  • -o .github/workflows/trigger-code-simplifier.yml && \
    Suggested fix:
  • curl -fsSL https://raw.githubusercontent.com/elastic/ai-github-actions/v0/gh-agent-workflows/code-complexity-detector/example.yml \
  • -o .github/workflows/trigger-code-complexity-detector.yml && \
    Why: gh-agent-workflows/code-simplifier/ is no longer present, while gh-agent-workflows/code-complexity-detector/ exists. The current install command is misleading and likely broken.

2. Typo in maintainer-facing workflow prompt text

File: .github/workflows/gh-aw-mention-in-issue.md (line 141)
Current text: Unless instructred otherwise, if you do create an issue or a pull request, assign it to the user who requested the change that resulted in the creation of the issue or pull request.
Suggested fix: Unless instructed otherwise, if you do create an issue or a pull request, assign it to the user who requested the change that resulted in the creation of the issue or pull request.
Why: Clear spelling error in user-facing instruction text.

3. Log-extractor help text says it extracts only errors, but it also matches warnings

File: scripts/extract-log-errors.py (lines 3 and 101; behavior evidence at line 33)
Current text:

  • Module docstring: Extract errors and failures from GitHub Actions log files.
  • CLI description: Extract errors from GitHub Actions log files.
    Suggested fix:
  • Extract warnings, errors, and failures from GitHub Actions log files.
    Why: DEFAULT_PATTERNS includes r"##\[warning\]" (line 33), so current user-facing wording is misleading relative to behavior.

Completeness Pass (verified occurrences)

  • instructred -> 1 user-facing source occurrence in .github/workflows/gh-aw-mention-in-issue.md.
  • code-simplifier/example.yml and trigger-code-simplifier.yml -> 2 occurrences, both in docs/index.md lines 112-113.
  • Extract errors and failures from GitHub Actions log files. -> 1 occurrence (scripts/extract-log-errors.py:3).
  • Extract errors from GitHub Actions log files. -> 1 occurrence (scripts/extract-log-errors.py:101).

Suggested Actions

  • Update docs/index.md lines 112-113 to use code-complexity-detector in both URL and output filename.
  • Fix instructred -> instructed in .github/workflows/gh-aw-mention-in-issue.md.
  • Align scripts/extract-log-errors.py user-facing descriptions with actual behavior (including warnings).

What is this? | From workflow: Trigger Text Auditor

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

  • expires on Mar 26, 2026, 1:42 PM UTC

Activity

  1. github-actions commented on Mar 26, 2026

    @github-actions
    ContributorAuthor

    This issue was automatically closed because it expired on 2026-03-26T13:42:09.810Z.

    Closed by Workflow

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions