elastic / elastic/ai-github-actions

[information-architecture] Flaky Test Investigator hides required CI workflow-name customization

Open
#1,665 0 comments 0 reactions 0 assignees View on GitHub
information-architecture
Dominant language
Python
Stars
11
Forks
16
Avg merge
22h 9m
Merged PRs (30d)
31

Description

## Information Architecture Findings

### 1. Failed-CI trigger is disconnected from the repository
**Area:** Action placement
**Component(s):** `gh-agent-workflows/flaky-test-investigator/example.yml`, `gh-agent-workflows/flaky-test-investigator/README.md`, `docs/workflows/gh-agent-workflows.md`
**Problem:** The copy-paste trigger subscribes only to workflow runs named `CI`, `Build`, and `Test` (`example.yml:6-8`), but the Quick Install instructions and trigger table never tell users to replace those names. Repositories using names such as `Continuous Integration` therefore receive no event-driven investigations, while the catalog still presents the workflow as handling failed CI runs. The only remaining triggers are the weekday schedule and manual dispatch, so the failure is silent rather than an obvious configuration error.
**Suggested improvement:** Add an explicit required customization immediately beside the Quick Install example (or use a repository-configurable input) and show the workflow-name replacement in the example. State in the trigger table that `workflow_run.workflows` must match the consumer repository’s actual CI workflow names.

## Suggested Actions
- [ ] Make the CI workflow-name list an explicit setup step in the Quick Install path.
- [ ] Update the trigger documentation to explain that unmatched workflow names prevent failed-CI event runs.
- [ ] Consider replacing the hardcoded list with a clearly documented consumer input or configuration pattern.

> [!WARNING]
>
> Firewall blocked 1 domain
>
> The following domain was blocked by the firewall during workflow execution:
>
> - `awmgmcpg`
>> To allow these domains, add them to the `network.allowed` list in your workflow frontmatter:
>
> ```yaml
> network:
> allowed:
> - defaults
> - "awmgmcpg"
> ```
>
> See [Network Configuration](https://github.github.com/gh-aw/reference/network/) for more information.
>
>

---
[What is this?](https://ela.st/github-ai-tools) | [From workflow: Trigger Information Architecture](https://github.com/elastic/ai-github-actions/actions/runs/30029877997)

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.