Skip to content

[docs] docs: document --enable-opencode flag for gated OpenCode API proxy port#2345

Merged
lpcox merged 2 commits intomainfrom
docs/sync-opencode-flag-2026-05-01-f0356ee14105d384
May 1, 2026
Merged

[docs] docs: document --enable-opencode flag for gated OpenCode API proxy port#2345
lpcox merged 2 commits intomainfrom
docs/sync-opencode-flag-2026-05-01-f0356ee14105d384

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented May 1, 2026

Documentation Sync - 2026-04-24 to 2026-05-01

This PR synchronizes documentation with the code change from the past 7 days that gated the OpenCode API proxy listener behind an explicit CLI flag.

Changes Made

  • docs/usage.md: Added --enable-opencode flag to the CLI reference section, noting it requires --enable-api-proxy
  • docs/api-proxy-sidecar.md: Updated port 10004 description to note it requires --enable-opencode
  • docs/awf-config-spec.md: Added apiProxy.enableOpenCode--enable-opencode CLI mapping

Code Changes Referenced

  • Commit bab8694: fix: gate OpenCode listener (port 10004) on explicit AWF_ENABLE_OPENCODE flag (#2337) — added --enable-opencode CLI flag, validates it requires --enable-api-proxy, and sets AWF_ENABLE_OPENCODE=true env var in the api-proxy container only when the flag is present. Port 10004 is now inactive unless explicitly requested.

Verification

  • Code examples checked against src/cli.ts flag definitions
  • Flag description matches actual CLI help text in src/cli.ts:1527-1529
  • Config spec mapping matches src/types.ts (enableOpenCode field) and src/docker-manager.ts
  • Consistent with existing documentation style

Generated by Documentation Maintainer · ● 1.7M ·

Port 10004 (OpenCode) in the API proxy sidecar is now gated behind an
explicit --enable-opencode flag (requires --enable-api-proxy). Update
docs to reflect this.

- docs/usage.md: add --enable-opencode to flag reference
- docs/api-proxy-sidecar.md: note port 10004 requires --enable-opencode
- docs/awf-config-spec.md: add apiProxy.enableOpenCode CLI mapping

Triggered by: bab8694 (fix: gate OpenCode listener on AWF_ENABLE_OPENCODE flag)

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

github-actions Bot commented May 1, 2026

Documentation Preview

Documentation build failed for this PR. View logs.

Built from commit eed9494

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@lpcox
Copy link
Copy Markdown
Collaborator

lpcox commented May 1, 2026

@copilot address the review feedback

Copy link
Copy Markdown
Contributor

Copilot AI commented May 1, 2026

@copilot address the review feedback

Addressed in 822bfb6. The main gap was that docs/awf-config.schema.json was missing the enableOpenCode field in the apiProxy section. Since the schema uses additionalProperties: false, any config file using apiProxy.enableOpenCode: true would have failed schema validation. The field was added to src/config-file.ts in bab8694 but the schema wasn't updated at that time.

Copilot finished work on behalf of lpcox May 1, 2026 14:42
Copilot AI requested a review from lpcox May 1, 2026 14:42
@github-actions
Copy link
Copy Markdown
Contributor Author

github-actions Bot commented May 1, 2026

✅ Coverage Check Passed

Overall Coverage

Metric Base PR Delta
Lines 85.87% 85.95% 📈 +0.08%
Statements 85.86% 85.94% 📈 +0.08%
Functions 87.96% 87.96% ➡️ +0.00%
Branches 79.96% 80.00% 📈 +0.04%
📁 Per-file Coverage Changes (1 files)
File Lines (Before → After) Statements (Before → After)
src/docker-manager.ts 87.4% → 87.7% (+0.29%) 87.0% → 87.3% (+0.27%)

Coverage comparison generated by scripts/ci/compare-coverage.ts

@github-actions
Copy link
Copy Markdown
Contributor Author

github-actions Bot commented May 1, 2026

Smoke Test: Copilot BYOK — PASS

Test Result
GitHub MCP (list PRs)
GitHub.com connectivity ⚠️ pre-step data not expanded
File write/read ⚠️ pre-step data not expanded
BYOK inference (this response)

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

PR by @github-actions[bot] · Assignees: @Mossaka, @lpcox · Overall: PASS (core BYOK path verified)

🔑 BYOK report filed by Smoke Copilot BYOK

@github-actions
Copy link
Copy Markdown
Contributor Author

github-actions Bot commented May 1, 2026

🔬 Smoke Test Results

Test Status
GitHub MCP connectivity
GitHub.com HTTP connectivity ❌ (template vars unexpanded)
File write/read ❌ (template vars unexpanded)

PR: [docs] docs: document --enable-opencode flag for gated OpenCode API proxy port
Author: @github-actions[bot] | Assignees: none

Overall: FAIL — pre-step template variables ($\{\{ steps.smoke-data.outputs.* }}) were not substituted; HTTP and file test data unavailable.

📰 BREAKING: Report filed by Smoke Copilot

@github-actions
Copy link
Copy Markdown
Contributor Author

github-actions Bot commented May 1, 2026

Smoke Test Results

✅ GitHub MCP: Last 2 merged PRs (#2339, #2337)
✅ Playwright: github.com title verified
✅ File Writing: Test file created successfully
✅ Bash: File verification passed

Overall: PASS

💥 [THE END] — Illustrated by Smoke Claude

@github-actions
Copy link
Copy Markdown
Contributor Author

github-actions Bot commented May 1, 2026

feat(api-proxy): write models.json snapshot after startup model fetch
fix: gate OpenCode listener (port 10004) on explicit AWF_ENABLE_OPENCODE flag
GitHub merged review ✅
GH CLI PR query ✅
Playwright title ✅
Tavily search ❌
File write/read ✅
Discussion comment ✅
Build ✅
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

github-actions Bot commented May 1, 2026

Smoke Test: GitHub Actions Services Connectivity

Check Result
Redis PING ❌ Timeout (no response)
PostgreSQL pg_isready ❌ No response
PostgreSQL SELECT 1 ❌ No response

Overall: FAILhost.docker.internal is unreachable on both ports 6379 and 5432. Service containers may not be running or host networking is not available in this environment.

🔌 Service connectivity validated by Smoke Services

@github-actions
Copy link
Copy Markdown
Contributor Author

github-actions Bot commented May 1, 2026

🏗️ 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 #2345 · ● 737.7K ·

@github-actions
Copy link
Copy Markdown
Contributor Author

github-actions Bot commented May 1, 2026

Smoke Test: Gemini Engine Validation

  • GitHub MCP Testing: ✅
  • GitHub.com Connectivity: ✅ (HTTP 200)
  • File Write/Read Test: ✅

Overall Status: PASS

@Copilot @assignees

💎 Faceted by Smoke Gemini

@lpcox lpcox merged commit b69948f into main May 1, 2026
62 of 66 checks passed
@lpcox lpcox deleted the docs/sync-opencode-flag-2026-05-01-f0356ee14105d384 branch May 1, 2026 15:16
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.

2 participants