Skip to content

features.md

Latest commit

聽

History

History
39 lines (33 loc) 路 3.88 KB

features.md

File metadata and controls

39 lines (33 loc) 路 3.88 KB
Raw

Features

The eight FEATURE_* settings are pr-agent's entire user-facing configuration. Everything else is deployment wiring or operator tuning (see configuration.md).

Modes: off = disabled entirely (slash commands reply with a notice, nothing runs), manual = slash command only, auto = slash command plus an automatic trigger. Auto triggers are fixed: review and describe fire when a PR is opened; verification fires on synchronize (every push). A push while an auto review is still running cancels that review and replaces it with one for the new head; a push after the review finishes does not re-review. Custom trigger sets are intentionally not supported.

Setting Values Default Spends tokens? What it does
FEATURE_REVIEW manual | auto auto yes Orchestrated review. auto reviews each PR when opened; /review is always available.
FEATURE_DESCRIBE off | manual | auto auto yes PR description generation. auto runs when a PR opens; /describe re-runs on demand.
FEATURE_VERIFICATION off | manual | auto auto yes Re-checks open findings on synchronize or on-demand /verify. Silently resolves fixed threads and edits stubs. Terminal failure edits the CI cell or one stub line.
FEATURE_ASK off | manual manual yes /ask and @bot question threads.
FEATURE_TRIAGE off | manual manual yes /triage autofix plus /triage preview then /triage all (preview required before bulk).
FEATURE_REVIEW_LABELS off | size | size+security size no Review size / security labels synced onto the PR.
FEATURE_COMMIT_STATUS false | true false no Posts the pr-agent/review commit status on the PR head; usable in branch protection rules.
FEATURE_TITLE_REWRITE false | true false no Allows /describe to rewrite the PR title.

Notes:

  • FEATURE_REVIEW has no off: review is the product; /review always works.
  • Describe, verification, ask, and triage can be turned off to stop those surfaces from spending tokens at all.
  • Invalid values fail startup with the allowed list; typos never silently disable a feature.
  • Pre-revision variables (ENABLE_*, *_AUTO_ACTIONS, DESCRIPTION_GENERATE_TITLE, and the old tuning knobs) are ignored; use FEATURE_* only. There are no aliases.

Defaults reproduce the pre-revision out-of-the-box behavior exactly. CI enforces that every FEATURE_* key is documented here (test/settingsInventory.test.ts).