Skip to content

Commit 69478ce

Browse files
docs(docker-compose): update Copilot CLI documentation for runtime model
Changes: - README: clarify Copilot CLI is runtime support, not template - copilot-cli-troubleshooting: update for standard image tag behavior - en-US.json: update translations for standard tag semantics - zh-CN.json: update translations for standard tag semantics Updates documentation to reflect that Copilot CLI is now treated as a standard executor while the Hagicode image tag remains fixed at 0. Co-Authored-By: Hagicode <noreply@hagicode.com>
1 parent 6ac6da6 commit 69478ce

4 files changed

Lines changed: 26 additions & 24 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A modern Docker Compose configuration generator for Hagicode, built with React +
88
- **Docker Compose YAML Generation**: Automatic YAML file generation based on user input
99
- **Multiple Database Options**: Support for internal PostgreSQL or external database connections
1010
- **Explicit Executor Configuration**: Enable Claude/Codex/Copilot CLI/CodeBuddy/IFlow/OpenCode in parallel without a default-provider route
11-
- **Copilot CLI Docker Template**: Built-in `copilot-cli` template with release-index defaults and strict `<version>-copilot` tag validation
11+
- **Copilot CLI Support**: Optional `copilot-cli` executor support while the standard Hagicode image tag remains fixed at `0`
1212
- **LAN HTTPS Support**: Optional Caddy reverse proxy with `tls internal`
1313
- **Volume Management**: Configure volume mounts for data persistence
1414
- **User Permissions**: Linux user permission mapping (PUID/PGID) support
@@ -110,20 +110,20 @@ This will build the application and deploy it to the `gh-pages` branch.
110110
|----------|-------------|------------|-----------------|
111111
| Claude | Provider preset, token, optional custom endpoint | Requires token; custom preset also requires endpoint URL | Emits `ANTHROPIC_*` variables for the enabled Claude branch |
112112
| Codex | `CODEX_API_KEY`, optional `CODEX_BASE_URL` | Requires `CODEX_API_KEY` when enabled | Emits `CODEX_*` variables only |
113-
| Copilot CLI | `COPILOT_API_KEY`, optional `COPILOT_BASE_URL`, image tag, workspace toggle | Requires API key and `<version>-copilot` image tag when enabled | Emits `COPILOT_*` variables and optional sidecar service |
113+
| Copilot CLI | `COPILOT_API_KEY`, optional `COPILOT_BASE_URL`, standard image tag `0`, workspace toggle | Requires API key when enabled | Emits `COPILOT_*` variables and optional sidecar service without changing the standard Hagicode image tag |
114114
| CodeBuddy | `CODEBUDDY_API_KEY`, `CODEBUDDY_INTERNET_ENVIRONMENT` | Requires API key when enabled; network environment defaults to `ioa` but remains editable | Emits explicit CodeBuddy provider/platform keys plus `CODEBUDDY_*` variables |
115115
| IFlow CLI | Informational branch only | No invented private `IFLOW_*` field is required | Emits explicit IFlow provider/platform bootstrap keys and expects prior CLI login or mounted runtime state |
116116
| OpenCode | Optional managed runtime model | No extra required field beyond normal deployment validation | Emits explicit OpenCode provider registration plus `AI__OpenCode__*` managed runtime keys |
117117

118-
##### Copilot CLI Template
118+
##### Copilot CLI Runtime Notes
119119

120-
- **Template ID**: `copilot-cli`
120+
- **Template ID**: `copilot-cli` (reserved for explicit template flows)
121121
- **Required env**: `COPILOT_API_KEY`
122-
- **Tag policy**: `imageTag` must match `<version>-copilot` (for example `1.2.3-copilot`)
122+
- **Standard tag contract**: the standard Hagicode image tag stays fixed at `0`
123123
- **Optional env**: `COPILOT_BASE_URL`
124124
- **Workspace mount**: Optional bind mount to `/workspace`
125125

126-
Copilot template defaults are loaded from release index metadata. If loading fails, the app falls back to safe embedded defaults.
126+
Release index metadata remains available for compatibility checks and future explicit Copilot template flows. Standard builder defaults and refresh paths keep `imageTag` at `0`.
127127

128128
##### CodeBuddy, IFlow, and OpenCode Notes
129129

docs/copilot-cli-troubleshooting.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
1-
# Copilot CLI Template Troubleshooting
1+
# Copilot CLI Runtime Troubleshooting
22

3-
This guide covers common issues when using the `copilot-cli` template in Docker Compose Builder.
3+
This guide covers common issues when enabling the `copilot-cli` executor in Docker Compose Builder.
44

55
## 1. Release index metadata cannot be loaded
66

77
**Symptoms**
8-
- Copilot template shows fallback warning
9-
- Default `imageTag` is not the expected release tag
8+
- Copilot metadata warning is shown
9+
- You want to confirm whether metadata changes the standard `imageTag`
1010

1111
**Checks**
1212
1. Verify the release index URL is reachable
1313
2. If needed, override index URL with `VITE_RELEASE_INDEX_URL`
1414
3. Confirm payload includes `copilot.provider = "copilot-cli"`
15+
4. Standard builder flows should still keep `imageTag = 0`; metadata is informational unless an explicit template flow opts in
1516

16-
## 2. Image tag validation fails
17+
## 2. Standard image tag unexpectedly changes
1718

1819
**Symptoms**
19-
- Validation error on `imageTag`
20-
- YAML generation blocked
20+
- `imageTag` is no longer `0` in a standard builder flow
21+
- Generated standard image reference does not end with `:0`
2122

2223
**Expected format**
23-
- `<version>-copilot` (example: `1.2.3-copilot`)
24+
- Standard builder flows keep `imageTag` fixed at `0`
2425

2526
**Fix**
26-
1. Use a semantic version with `-copilot` suffix
27-
2. Avoid non-version tags such as `latest` for copilot template
27+
1. Reset the builder or switch profiles once to re-normalize older saved state
28+
2. Refresh the page after upgrading to a build that includes the tag fix
29+
3. If the problem persists, clear the stored builder config from localStorage and reload
2830

2931
## 3. Missing `COPILOT_API_KEY`
3032

src/i18n/locales/en-US.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,15 +131,15 @@
131131
"openCodeModel": "OpenCode Model",
132132
"openCodeModelHint": "Optional managed runtime model. The image ships the opencode command even though routing is configured explicitly.",
133133
"copilotConfiguration": "Copilot CLI Configuration",
134-
"copilotDescription": "Configure Copilot runtime using COPILOT_* environment variables and copilot image tag policy",
134+
"copilotDescription": "Configure Copilot runtime using COPILOT_* environment variables while the standard Hagicode image tag stays fixed at 0",
135135
"copilotMountWorkspace": "Mount workspace volume to /workspace",
136136
"loadingCopilotMetadata": "Loading Copilot release metadata...",
137-
"copilotMetadataHint": "Using release index defaults (env schema v{{version}})",
138-
"copilotMetadataFallback": "Failed to fetch release index metadata. Fallback defaults are applied.",
137+
"copilotMetadataHint": "Release index metadata is available for compatibility checks (env schema v{{version}}); the standard image tag remains 0",
138+
"copilotMetadataFallback": "Failed to fetch release index metadata. The standard image tag remains 0.",
139139
"standardTemplate": "Standard Template",
140140
"standardTemplateDescription": "Default Hagicode application template",
141141
"copilotTemplate": "Copilot CLI Template",
142-
"copilotTemplateDescription": "Copilot-focused template with strict tag and environment validation",
142+
"copilotTemplateDescription": "Reserved for explicit Copilot template flows; the standard builder keeps imageTag at 0",
143143
"optional": "optional",
144144
"compatibilityAliasHint": "Compatibility Alias Hint",
145145
"codexCompatibilityDescription": "You can also use OPENAI_* environment variables as compatibility aliases",

src/i18n/locales/zh-CN.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,15 +131,15 @@
131131
"openCodeModel": "OpenCode 模型",
132132
"openCodeModelHint": "可选的托管运行时模型。镜像内仍然提供 opencode 命令,但路由改为显式配置。",
133133
"copilotConfiguration": "Copilot CLI 配置",
134-
"copilotDescription": "使用 COPILOT_* 环境变量配置 Copilot 运行时,并遵循 copilot 镜像标签规则",
134+
"copilotDescription": "使用 COPILOT_* 环境变量配置 Copilot 运行时,同时保持标准 Hagicode 镜像标签固定为 0",
135135
"copilotMountWorkspace": "挂载工作目录到 /workspace",
136136
"loadingCopilotMetadata": "正在加载 Copilot 发布索引元数据...",
137-
"copilotMetadataHint": "正在使用发布索引默认值(环境 schema v{{version}})",
138-
"copilotMetadataFallback": "拉取发布索引元数据失败,已使用回退默认值",
137+
"copilotMetadataHint": "发布索引元数据可用于兼容性检查(环境 schema v{{version}});标准镜像标签仍保持为 0",
138+
"copilotMetadataFallback": "拉取发布索引元数据失败,但标准镜像标签仍保持为 0",
139139
"standardTemplate": "标准模板",
140140
"standardTemplateDescription": "默认 Hagicode 应用模板",
141141
"copilotTemplate": "Copilot CLI 模板",
142-
"copilotTemplateDescription": "面向 Copilot 的模板,包含严格标签与环境校验",
142+
"copilotTemplateDescription": "仅供显式 Copilot 模板流程使用;标准构建器会将 imageTag 保持为 0",
143143
"optional": "可选",
144144
"compatibilityAliasHint": "兼容别名提示",
145145
"codexCompatibilityDescription": "您也可以使用 OPENAI_* 环境变量作为兼容别名",

0 commit comments

Comments
 (0)