elastic / elastic/ai-github-actions

[information-architecture] PR Buildkite Detective setup example duplicates the secrets block

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

Description

## Information Architecture Findings

### 1. PR Buildkite Detective example separates users from a valid secret wiring pattern
**Area:** Action placement / Setup controls
**Component(s):** `docs/workflows/gh-agent-workflows/estc-pr-buildkite-detective.md`, `gh-agent-workflows/estc-pr-buildkite-detective/example.yml`

**Problem:** The PR Buildkite Detective page correctly tells users that `BUILDKITE_API_TOKEN` is required (`docs/workflows/gh-agent-workflows/estc-pr-buildkite-detective.md:40-42`), but the adjacent copy-paste example renders two consecutive `secrets:` keys (`docs/workflows/gh-agent-workflows/estc-pr-buildkite-detective.md:83-86`). The source example has the expected single `secrets:` block (`gh-agent-workflows/estc-pr-buildkite-detective/example.yml:19-21`). Users following the setup page are likely to copy invalid or confusing workflow YAML exactly where the required provider secret should be configured.

**Suggested improvement:** Replace the published example with the canonical `gh-agent-workflows/estc-pr-buildkite-detective/example.yml` content, or remove the duplicate `secrets:` line so the required `BUILDKITE_API_TOKEN` wiring appears once in the context where users copy it.

## Suggested Actions
- [ ] Remove the duplicate `secrets:` key from the PR Buildkite Detective docs example.
- [ ] Keep the published example in sync with `gh-agent-workflows/estc-pr-buildkite-detective/example.yml` so required secret setup remains unambiguous.

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

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

Contributor guide

Open the contributing guide

Research direction

Compare the published example in docs/workflows/gh-agent-workflows/estc-pr-buildkite-detective.md around lines 83-86 with gh-agent-workflows/estc-pr-buildkite-detective/example.yml around lines 19-21. Remove the duplicate secrets: entry or replace the published block with the canonical content. Done means the documentation contains one unambiguous secrets block wiring BUILDKITE_API_TOKEN and remains aligned with the source example.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.