Skip to content

[docs] docs: sync Gemini proxy documentation with conditional setup behavior#2297

Merged
lpcox merged 1 commit intomainfrom
docs/sync-gemini-conditional-setup-8cd6c2fa0d35fecf
Apr 29, 2026
Merged

[docs] docs: sync Gemini proxy documentation with conditional setup behavior#2297
lpcox merged 1 commit intomainfrom
docs/sync-gemini-conditional-setup-8cd6c2fa0d35fecf

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Documentation Sync - April 29, 2026

This PR synchronizes documentation with code changes from the past 7 days.

Changes Made

  • Updated docs/api-proxy-sidecar.md: Corrected the environment variable table and note for Gemini — these are no longer set unconditionally when --enable-api-proxy is active; they are now conditional on GEMINI_API_KEY being provided to the host AWF process.

Code Changes Referenced

  • Commit cb8ca4b: fix: make ~/.gemini setup conditional on geminiApiKey (#2282) — changed GEMINI_API_BASE_URL, GEMINI_API_KEY placeholder, ~/.gemini home directory mount, and the AWF_GEMINI_ENABLED signal to only be set when geminiApiKey is configured, avoiding spurious log entries in non-Gemini runs.

Verification

  • Code examples tested/verified
  • Links checked
  • Consistent with existing style

Details

The old documentation stated:

GEMINI_API_BASE_URL and the GEMINI_API_KEY placeholder are always set in the agent when --enable-api-proxy is active, regardless of whether GEMINI_API_KEY is present in the runner environment.

After cb8ca4b, this is no longer accurate. Both env vars, the ~/.gemini directory mount, and AWF_GEMINI_ENABLED are gated behind if (config.geminiApiKey) checks in src/docker-manager.ts.

Generated by Documentation Maintainer · ● 962.3K ·

GEMINI_API_BASE_URL, GEMINI_API_KEY placeholder, ~/.gemini mount, and
AWF_GEMINI_ENABLED are now only set when GEMINI_API_KEY is provided to
the host AWF process (conditional on geminiApiKey). Update documentation
to remove the now-incorrect 'always set unconditionally' note.

Refs: cb8ca4b (fix: make ~/.gemini setup conditional on geminiApiKey)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot requested a review from Mossaka as a code owner April 29, 2026 13:03
@github-actions github-actions Bot added ai-generated documentation Improvements or additions to documentation labels Apr 29, 2026
@github-actions
Copy link
Copy Markdown
Contributor Author

Documentation Preview

Documentation build failed for this PR. View logs.

Built from commit d5d78ba

@github-actions
Copy link
Copy Markdown
Contributor Author

Smoke Test Results

✅ GitHub MCP: Last 2 merged PRs retrieved

✅ Playwright: github.com page title contains "GitHub"
✅ File Writing: Test file created and verified
✅ Bash: Commands executed successfully

Status: PASS

💥 [THE END] — Illustrated by Smoke Claude

@github-actions
Copy link
Copy Markdown
Contributor Author

Smoke Test: Copilot BYOK (Offline) Mode

Test Result
1. GitHub MCP (list PRs) ✅ Latest merged PR: "fix: make ~/.gemini setup conditional on geminiApiKey" (#2282)
2. GitHub.com HTTP ⚠️ Pre-step data unavailable (template vars not substituted)
3. File write/read ⚠️ Pre-step data unavailable (template vars not substituted)
4. BYOK inference ✅ Responding via api-proxy → api.githubcopilot.com

Running in BYOK offline mode (COPILOT_OFFLINE=true) via api-proxy → api.githubcopilot.com.

PR author: @github-actions[bot] · Reviewer: @Mossaka

Overall: PARTIAL (MCP + BYOK ✅; pre-step data missing for HTTP/file tests)

🔑 BYOK report filed by Smoke Copilot BYOK

@github-actions
Copy link
Copy Markdown
Contributor Author

🔥 Smoke Test Results

Test Result
GitHub MCP connectivity
GitHub.com HTTP (200)
File write/read

PR: [docs] docs: sync Gemini proxy documentation with conditional setup behavior
Author: @github-actions[bot] · No assignees

Overall: PASS

📰 BREAKING: Report filed by Smoke Copilot

@github-actions
Copy link
Copy Markdown
Contributor Author

Smoke Test

PRs: "fix: make ~/.gemini setup conditional on geminiApiKey" | "perf(security-guard): eliminate redundant API call and raise diff pre-fetch limit to 100 KB"
GitHub MCP: ❌
safeinputs-gh PR query: ❌
Playwright title: ✅
Tavily search: ❌
File write/read: ✅
Discussion comment: ✅
Build AWF: ✅
Overall: FAIL

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • registry.npmjs.org

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "registry.npmjs.org"

See Network Configuration for more information.

🔮 The oracle has spoken through Smoke Codex

@github-actions
Copy link
Copy Markdown
Contributor Author

🏗️ Build Test Suite Results

Ecosystem Project Build/Install Tests Status
Bun elysia 1/1 passed ✅ PASS
Bun hono 1/1 passed ✅ PASS
C++ fmt N/A ✅ PASS
C++ json N/A ✅ PASS
Deno oak N/A 1/1 passed ✅ PASS
Deno std N/A 1/1 passed ✅ PASS
.NET hello-world N/A ✅ PASS
.NET json-parse N/A ✅ PASS
Go color 1/1 passed ✅ PASS
Go env 1/1 passed ✅ PASS
Go uuid 1/1 passed ✅ PASS
Java gson 1/1 passed ✅ PASS
Java caffeine 1/1 passed ✅ PASS
Node.js clsx All passed ✅ PASS
Node.js execa All passed ✅ PASS
Node.js p-limit All passed ✅ PASS
Rust fd 1/1 passed ✅ PASS
Rust zoxide 1/1 passed ✅ PASS

Overall: 8/8 ecosystems passed — ✅ PASS

Generated by Build Test Suite for issue #2297 · ● 391.6K ·

@lpcox lpcox merged commit 07079b7 into main Apr 29, 2026
53 of 57 checks passed
@lpcox lpcox deleted the docs/sync-gemini-conditional-setup-8cd6c2fa0d35fecf branch April 29, 2026 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant