Skip to content

docs(#3552): add mode-dependent configure() options guidance - #3553

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/3552-configure-mode-guidance
Open

docs(#3552): add mode-dependent configure() options guidance#3553
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/3552-configure-mode-guidance

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Add a new Mode-Dependent configure() Options subsection to the E2E Testing section of AGENTS.md, placed after the Plugin Metadata Resolution table.

Documents two configure() options with mode-dependent behavior:

  • disablePlugins: only effective in PR and local dev modes where
    auto-generation runs; silently ignored in nightly mode. Advises
    against unnecessary conditional guards since the option is
    already a no-op in nightly mode.

  • dynamicPlugins: has destructive side effects in nightly mode
    (generates disabled:true for baked-in plugins). Documents when
    a mode guard is needed vs not. Cross-references Add AGENTS.md guidance for baked-in plugin E2E test configuration #3112 for
    baked-in plugin guidance.

Includes review guidance for agents to flag unnecessary mode guards around disablePlugins and missing mode guards around dynamicPlugins.


Closes #3552

Post-script verification

  • Branch is not main/master (agent/3552-configure-mode-guidance)
  • Secret scan passed (gitleaks — de1e7b92a96b94cc158cb2e943995ebbe1adde18..HEAD)
  • Pre-commit hooks passed (authoritative run on runner)
  • Tests ran inside sandbox

Add a new Mode-Dependent configure() Options subsection to the
E2E Testing section of AGENTS.md, placed after the Plugin Metadata
Resolution table.

Documents two configure() options with mode-dependent behavior:

- disablePlugins: only effective in PR and local dev modes where
  auto-generation runs; silently ignored in nightly mode. Advises
  against unnecessary conditional guards since the option is
  already a no-op in nightly mode.

- dynamicPlugins: has destructive side effects in nightly mode
  (generates disabled:true for baked-in plugins). Documents when
  a mode guard is needed vs not. Cross-references #3112 for
  baked-in plugin guidance.

Includes review guidance for agents to flag unnecessary mode
guards around disablePlugins and missing mode guards around
dynamicPlugins.

Closes #3552
@openshift-ci

openshift-ci Bot commented Sep 3, 2026

Copy link
Copy Markdown

Hi @fullsend-ai-coder[bot]. Thanks for your PR.

I'm waiting for a redhat-developer member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@sonarqubecloud

sonarqubecloud Bot commented Sep 3, 2026

Copy link
Copy Markdown

@fullsend-ai-review

fullsend-ai-review Bot commented Sep 3, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 3:27 PM UTC · Completed 3:44 PM UTC

Commit: c3f0429 · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Cost: $4.52

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium

  • [internal-consistency] AGENTS.md — The prose states that disablePlugins "only has effect in PR mode (when GIT_PR_NUMBER is set)" but the table immediately below lists Local dev mode as also having the effect (Auto-generation runs: Yes, disablePlugins effect: "Removes named plugins from generated config"). The same sentence confirms both modes: "auto-generation only runs in PR and local dev modes." The bold claim contradicts both the table and the supporting sentence.
    Remediation: Change "It only has effect in PR mode" to "It only has effect when auto-generation runs (PR and local dev modes)" or equivalently "It has no effect in nightly mode".

  • [protected-path] AGENTS.md — This file is a protected path requiring human approval. The PR links to issue Add AGENTS.md guidance for configure() option mode dependencies beyond dynamicPlugins #3552 and explains the rationale for the change. Human approval is always required for protected-path changes, regardless of context.

Low

  • [internal-consistency] AGENTS.md — The new section claims auto-generation only runs in PR and local dev modes, but existing lines 287 and 316 describe auto-generation without mode qualifiers, which could confuse readers. Consider adding a mode qualifier parenthetical to those lines (e.g., "auto-generates from metadata/*.yaml if no dynamic-plugins.yaml exists (in PR and local dev modes)").

  • [document-structure-consistency] AGENTS.md — The new section introduces #### headings (#### disablePlugins, #### dynamicPlugins, #### Review guidance), but the rest of the file exclusively uses a flat ##/### heading hierarchy (33 existing ### subsections, zero ####). Consider flattening to bold text sub-topics within the ### Mode-Dependent configure() Options section, matching the approach used elsewhere in the file.


Labels: PR modifies only AGENTS.md documentation outside workspace directories.

@fullsend-ai-review fullsend-ai-review Bot added requires-manual-review Review requires human judgment documentation Improvements or additions to documentation non-workspace-changes PR changes files outside workspace directories labels Sep 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation needs-ok-to-test non-workspace-changes PR changes files outside workspace directories requires-manual-review Review requires human judgment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add AGENTS.md guidance for configure() option mode dependencies beyond dynamicPlugins

0 participants