elastic / elastic/ai-github-actions
[autonomy-atomicity] MkDocs publication trigger omits workflow documentation sources
- Dominant language
- Python
- Stars
- 11
- Forks
- 16
- Avg merge
- 22h 9m
- Merged PRs (30d)
- 31
Description
## Autonomy / Atomicity Findings
### 1. Workflow documentation changes do not trigger the Pages build
**Category:** Config hotspot
**File(s):** `.github/workflows/mkdocs.yml:4-10`, `docs/hooks.py:1-6,126-149`
**Problem:** The MkDocs workflow triggers on `docs/**`, `mkdocs.yml`, and `docs/requirements.txt`, but not on `gh-agent-workflows/**`. However, the MkDocs hook reads every `gh-agent-workflows/*/README.md` and `example.yml` and generates the published pages from those files. As a result, a contributor can merge an independent workflow documentation change and the Pages site will remain stale until an unrelated docs change or manual dispatch triggers a rebuild. This makes otherwise atomic documentation changes non-publishing and creates a shared publication-state dependency across parallel workflow contributors.
**Suggested fix:** Add `gh-agent-workflows/**` to the `push.paths` list in `.github/workflows/mkdocs.yml`, and add a regression check that changes to workflow README/example sources trigger the documentation workflow.
## Suggested Actions
- [ ] Include `gh-agent-workflows/**` in the MkDocs workflow path filters.
- [ ] Add CI coverage for publication-trigger coverage of generated workflow documentation sources.
---
[What is this?](https://ela.st/github-ai-tools) | [From workflow: Trigger Autonomy Atomicity Analyzer](https://github.com/elastic/ai-github-actions/actions/runs/29516035654)
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
Contributor guide
Research direction
Start with .github/workflows/mkdocs.yml:4-10 and docs/hooks.py:1-6,126-149 to compare the workflow path filters with the documentation sources the hook reads. Check how changes under gh-agent-workflows are handled, then add coverage for README.md and example.yml changes. Done means those source changes trigger the Pages build and the publication-trigger check passes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python, yaml
- Domain
- ci-cd, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100