elastic / elastic/ai-github-actions

[information-architecture] Continuous improvement setup hides stale issue auto-close

Open
#1,483 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. `--continuous-improvement` bundles an auto-closing workflow without surfacing that behavior
**Area:** Disclosure / Action placement
**Component(s):** `README.md:37-40`, `docs/workflows/gh-agent-workflows.md:22-27`, `gh-agent-workflows/README.md:63-80`, `scripts/quick-setup.sh:122-135`, `gh-agent-workflows/stale-issues-remediator/README.md:7-10,40-43`

**Problem:** The quick setup path presents `--continuous-improvement` as a normal recommended add-on bundle, but that bundle includes `stale-issues-remediator`, which can close issues after they have carried the stale label for 30+ days without objection. Users deciding whether to enable the bundle see only “selected continuous improvement workflows” / “recommended continuous improvement workflows” near the setup control, not that they are opting into automated issue closure.

**Evidence:**
- `README.md:37-40` says the quick setup script installs recommended workflows and that `--continuous-improvement` installs “selected continuous improvement workflows,” without calling out auto-closing behavior.
- `docs/workflows/gh-agent-workflows.md:22-27` lists `stale-issues-remediator` inside the continuous improvement add-ons bundle, again without a warning or explicit distinction from detector-style add-ons.
- `gh-agent-workflows/README.md:63-80` documents the same flag and list of workflows but does not separate remediation/closure workflows from detector workflows.
- `scripts/quick-setup.sh:122-135` confirms the flag installs `stale-issues-remediator` automatically as part of `continuous_improvement_workflows`.
- `gh-agent-workflows/stale-issues-remediator/README.md:7-10` explains that the workflow automatically closes issues after a 30-day expiry, and `gh-agent-workflows/stale-issues-remediator/README.md:40-43` lists `close-issue` as a safe output. That important behavior is only visible after navigating into the individual workflow page.

**Suggested improvement:** Split the quick setup bundle into detector-only add-ons and autonomous remediation/fixer add-ons, or add a prominent warning beside every `--continuous-improvement` mention that it includes workflows capable of closing issues and opening/fixing changes. In particular, call out `stale-issues-remediator` and link to its behavior before users copy the setup command.

## Suggested Actions
- [ ] Update quick setup docs to distinguish detector-only continuous improvement workflows from workflows that perform remediation such as issue closure.
- [ ] Add an explicit warning beside `--continuous-improvement` in `README.md`, `docs/workflows/gh-agent-workflows.md`, and `gh-agent-workflows/README.md`.
- [ ] Consider requiring a separate opt-in flag or custom `--workflows` example for `stale-issues-remediator` so users intentionally enable auto-closing behavior.

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

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

Contributor guide

Open the contributing guide

Research direction

Start by comparing the continuous-improvement descriptions in README.md, docs/workflows/gh-agent-workflows.md, and gh-agent-workflows/README.md with the bundle in scripts/quick-setup.sh:122-135. Read gh-agent-workflows/stale-issues-remediator/README.md:7-10,40-43 to confirm the auto-close behavior. Done means every --continuous-improvement mention clearly distinguishes remediation from detector workflows and warns or links before users enable it.

Written by the indexing model from the issue text.

Assessment

Tech stack
bash, github-actions
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.