mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-09-30 21:42:42 +02:00
docs: explain AI issue automation
This commit is contained in:
45
.github/ai/README.md
vendored
Normal file
45
.github/ai/README.md
vendored
Normal file
@@ -0,0 +1,45 @@
|
||||
# AI issue triage and draft fixes
|
||||
|
||||
`on_issues_ai.yml` handles new or reopened issues only when
|
||||
`.github/addon_submitters.json` does not map the mentioned add-on to another
|
||||
maintainer.
|
||||
|
||||
## Processing
|
||||
|
||||
1. A low-cost model classifies the issue using a strict JSON schema and an
|
||||
authoritative list of existing add-on directories.
|
||||
2. Straightforward questions receive an answer.
|
||||
3. Reports missing essential evidence receive focused questions.
|
||||
4. New add-on requests are marked for maintainer review and are never
|
||||
implemented by this automation.
|
||||
5. High-confidence improvements to existing add-ons proceed automatically to a
|
||||
draft fix attempt.
|
||||
6. Bugs opened by the repository owner proceed directly to Codex analysis;
|
||||
other bugs wait for a maintainer to add `ai: fix-approved`.
|
||||
7. Codex edits an isolated checkout without repository write permissions.
|
||||
8. A fresh job applies and validates the patch, pushes a branch, opens a draft
|
||||
pull request, and posts the root-cause report and pull-request URL.
|
||||
|
||||
The validator independently rejects new top-level add-on directories and Codex
|
||||
never merges pull requests.
|
||||
|
||||
## Required secret
|
||||
|
||||
- `OPENAI_API_KEY`: API key used for both structured triage and Codex.
|
||||
|
||||
## Optional secret
|
||||
|
||||
- `AI_PR_TOKEN`: fine-grained personal access token or GitHub App token with
|
||||
repository contents and pull-request write permissions. When absent, the
|
||||
workflow uses `GITHUB_TOKEN`. GitHub may require manual approval before CI
|
||||
runs on pull requests created with `GITHUB_TOKEN`.
|
||||
|
||||
## Optional repository variables
|
||||
|
||||
- `OPENAI_TRIAGE_MODEL`: defaults to `gpt-5-mini`.
|
||||
- `OPENAI_FIX_MODEL`: when empty, Codex uses its current default model.
|
||||
- `AI_MIN_CONFIDENCE`: defaults to `0.80`.
|
||||
- `AI_MAX_CHANGED_FILES`: defaults to `25`.
|
||||
- `AI_MAX_CHANGED_LINES`: defaults to `2000`.
|
||||
|
||||
The workflow creates its `ai:*` labels when it first runs.
|
||||
Reference in New Issue
Block a user