-
Notifications
You must be signed in to change notification settings - Fork 4
Description
Text Improvements
The following user-facing text issues were found in the repository. Each is a low-effort fix.
1. Security guidance uses a hard-to-parse double negative
File: SECURITY.md (line 15)
Current text: That doesn't mean that steps in the workflow prior to the Claude Code step will not run for external users.
Suggested fix: That means steps in the workflow prior to the Claude Code step can still run for external users.
Why: This sentence is difficult to parse in a security-critical section and can be misread.
2. Backward-compatibility note references the wrong path
File: docs/workflows/claude-workflows.md (line 9)
Current text: ...existing uses: elastic/ai-github-actions/claude-workflows/...@v0 references continue to work.
Suggested fix: ...existing uses: elastic/ai-github-actions/workflows/...@v0 references continue to work.
Why: The note says the directory was renamed from workflows/ to claude-workflows/, so the compatibility example should reference the legacy workflows/ path.
3. CLI help text understates what the script extracts
File: scripts/extract-log-errors.py (line 101)
Current text: Extract errors from GitHub Actions log files.
Suggested fix: Extract errors, warnings, and failures from GitHub Actions log files.
Why: Default patterns include warnings (##[warning]) and failure markers, so current wording is misleading.
4. Terminology is inconsistent within the same checklist
File: .github/workflows/upgrade-check.md (line 77)
Current text: Safe-output changes
Suggested fix: Safe-outputs changes (or standardize both lines to safe outputs)
Why: Line 74 uses safe-outputs; line 77 switches to singular, creating avoidable terminology drift.
Suggested Actions
- Rewrite the
SECURITY.mdline to remove the double negative. - Correct the legacy path example in
docs/workflows/claude-workflows.md. - Update the argparse description in
scripts/extract-log-errors.pyto match behavior. - Standardize
safe-output(s)wording in.github/workflows/upgrade-check.md.
What is this? | From workflow: Trigger Text Auditor
Give us feedback! React with π if perfect, π if helpful, π if not.
- expires on Mar 10, 2026, 1:36 PM UTC