Skip to content

Commit 5a9f332

Browse files
committed
chore(config): remove deprecation status for vendor apiKey
- Update documentation and configuration descriptions to reflect that the vendor API key remains a supported optional setting. - Remove the deprecation message from the package configuration. - Bump version to 0.8.9.
1 parent d415585 commit 5a9f332

6 files changed

Lines changed: 9 additions & 12 deletions

File tree

DEV.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ npm run test:pages
158158
## 多协议供应商接入说明
159159

160160
- 配置入口优先使用 `Coding Plans: Manage Vendor Configuration`。该命令从 `coding-plans.vendors` 动态生成供应商 QuickPick,选择供应商后可设置 API Key、刷新模型或打开供应商设置。
161-
- `coding-plans.vendors[].apiKey` 已标记为 deprecated,仅保留兼容用途;为保证 API Key 安全,建议优先使用 VS Code Secret Storage,而不是写入 `settings.json`。若此处仍配置了值,它会覆盖 Secret Storage 中同名供应商的 key。
161+
- `coding-plans.vendors[].apiKey` 仍可配置;为保证 API Key 安全,建议优先使用 VS Code Secret Storage,而不是写入 `settings.json`。若此处仍配置了值,它会覆盖 Secret Storage 中同名供应商的 key。
162162
- Copilot Chat 的原生 Add Models 表单只用于添加 `Coding Plans` provider group 和填写 Group Name;`vendorName/apiKey` 字段保留为旧 group 配置兼容项,不再作为必填交互。
163163
- VS Code 1.106+ 的 Language Models 页面引入了模型可见性控制。模型被 provider 成功发现后,仍需在 `Chat: Manage Language Models` 中通过眼睛图标将目标模型设为 `Show in the chat model picker`,否则它只会显示在管理页,不会出现在聊天模型下拉框。
164164
- 调试请求链路时,可通过 `coding-plans.logLevel` 控制输出面板日志级别;需要完整追踪时切到 `debug`,日常建议保持 `info`

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ code --install-extension techfetch-dev.coding-plans-for-copilot
145145
| `coding-plans.vendors` | `array` | 内置供应商模板 | 供应商配置列表。 |
146146
| `coding-plans.vendors[].name` | `string` | 必填 | 供应商唯一名称。 |
147147
| `coding-plans.vendors[].baseUrl` | `string` | 必填 | API 基础地址。 |
148-
| `coding-plans.vendors[].apiKey` | `string` || 已废弃。仅兼容使用;为保证安全,建议优先通过 VS Code Secret Storage 保存 API Key。若此处配置了值,会覆盖 Secret Storage 中同名供应商的 key。 |
148+
| `coding-plans.vendors[].apiKey` | `string` || 可选配置;为保证安全,建议优先通过 VS Code Secret Storage 保存 API Key。若此处配置了值,会覆盖 Secret Storage 中同名供应商的 key。 |
149149
| `coding-plans.vendors[].usageUrl` | `string` || 套餐 usage 接口地址,配置后状态栏显示额度百分比。 |
150150
| `coding-plans.vendors[].defaultApiStyle` | `string` | `openai-chat` | 协议风格:`openai-chat` / `openai-responses` / `anthropic`|
151151
| `coding-plans.vendors[].defaultTemperature` | `number` | `0.2` | 供应商默认 temperature。 |
@@ -174,7 +174,7 @@ code --install-extension techfetch-dev.coding-plans-for-copilot
174174
| `coding-plans.commitMessage.options.requireConventionalType` | `boolean` | `true` | 是否强制 Conventional Commits 类型。 |
175175
| `coding-plans.commitMessage.options.warnOnValidationFailure` | `boolean` | `true` | 校验失败时是否提示告警。 |
176176

177-
`coding-plans.vendors[].apiKey` 已标记为 deprecated,仅保留兼容用途
177+
`coding-plans.vendors[].apiKey` 仍然可用
178178
建议优先通过「设置 API Key」写入 VS Code Secret Storage,避免将密钥保存在 `settings.json` 中;若仍配置 `coding-plans.vendors[].apiKey`,它会覆盖 Secret Storage 中同名供应商的 key。
179179

180180
### 上下文窗口展示

README_en.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ The built-in Xiaomi MiMo default uses the Token Plan endpoint. If you want pay-a
148148
| `coding-plans.vendors` | `array` | Built-in vendor templates | Vendor configuration list. |
149149
| `coding-plans.vendors[].name` | `string` | Required | Vendor unique name. |
150150
| `coding-plans.vendors[].baseUrl` | `string` | Required | API base address. |
151-
| `coding-plans.vendors[].apiKey` | `string` | Empty | Deprecated. Kept for compatibility only; prefer VS Code Secret Storage for safer API key handling. When set, it overrides the same vendor key in Secret Storage. |
151+
| `coding-plans.vendors[].apiKey` | `string` | Empty | Optional setting. Prefer VS Code Secret Storage for safer API key handling. When set, it overrides the same vendor key in Secret Storage. |
152152
| `coding-plans.vendors[].usageUrl` | `string` | Empty | Plan usage API address; when configured, status bar displays quota percentage. |
153153
| `coding-plans.vendors[].defaultApiStyle` | `string` | `openai-chat` | Protocol style: `openai-chat` / `openai-responses` / `anthropic`. |
154154
| `coding-plans.vendors[].defaultTemperature` | `number` | `0.2` | Vendor default temperature. |
@@ -177,7 +177,7 @@ The built-in Xiaomi MiMo default uses the Token Plan endpoint. If you want pay-a
177177
| `coding-plans.commitMessage.options.requireConventionalType` | `boolean` | `true` | Whether to enforce Conventional Commits type. |
178178
| `coding-plans.commitMessage.options.warnOnValidationFailure` | `boolean` | `true` | Whether to show warning on validation failure. |
179179

180-
`coding-plans.vendors[].apiKey` is deprecated and kept only for compatibility.
180+
`coding-plans.vendors[].apiKey` is still supported.
181181
Prefer "Set API Key" so the key stays in VS Code Secret Storage instead of `settings.json`; if `coding-plans.vendors[].apiKey` is still set, it overrides the same vendor key in Secret Storage.
182182

183183
### Context Window Display

package.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "coding-plans-for-copilot",
33
"displayName": "%displayName%",
44
"description": "%description%",
5-
"version": "0.8.8",
5+
"version": "0.8.9",
66
"publisher": "techfetch-dev",
77
"repository": {
88
"type": "git",
@@ -240,8 +240,7 @@
240240
"apiKey": {
241241
"type": "string",
242242
"secret": true,
243-
"description": "%configuration.coding-plans.vendors.apiKey.description%",
244-
"deprecationMessage": "%configuration.coding-plans.vendors.apiKey.deprecationMessage%"
243+
"description": "%configuration.coding-plans.vendors.apiKey.description%"
245244
},
246245
"usageUrl": {
247246
"type": "string",

package.nls.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
"configuration.coding-plans.vendors.description": "Configure AI model vendors with their endpoints and models.",
99
"configuration.coding-plans.vendors.defaultTemperature.description": "Default temperature for this vendor. Models can override it individually. Recommended: 0.1-0.3 for coding, 0.3-0.5 for more creative output.",
1010
"configuration.coding-plans.vendors.defaultTopP.description": "Default top-p for this vendor. Models can override it individually. `0` means omit `top_p`, and is also the runtime default. Set a positive value only when you want to explicitly control nucleus sampling. `anthropic` requests ignore this value and do not send `top_p`.",
11-
"configuration.coding-plans.vendors.apiKey.description": "Deprecated vendor API key in settings. Prefer Secret Storage for better security. When set, this value overrides the same vendor key in Secret Storage.",
12-
"configuration.coding-plans.vendors.apiKey.deprecationMessage": "Deprecated: prefer Secret Storage to keep API keys out of settings.json.",
11+
"configuration.coding-plans.vendors.apiKey.description": "Optional vendor API key in settings. Prefer Secret Storage for better security. When set, this value overrides the same vendor key in Secret Storage.",
1312
"configuration.coding-plans.vendors.models.temperature.description": "Per-model temperature override. Inherits vendor defaultTemperature when omitted.",
1413
"configuration.coding-plans.vendors.models.topP.description": "Per-model top-p override. Inherits vendor defaultTopP when omitted. `0` means omit `top_p`. `anthropic` requests ignore this value and do not send `top_p`.",
1514
"providers.codingPlans.config.vendorName.title": "Vendor Name (optional)",

package.nls.zh-cn.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
"configuration.coding-plans.vendors.description": "配置 AI 模型供应商及其端点和模型。",
99
"configuration.coding-plans.vendors.defaultTemperature.description": "该供应商的默认 temperature,模型可单独覆盖。建议:代码生成/重构用 0.1-0.3,需更灵活表达时可用 0.3-0.5。",
1010
"configuration.coding-plans.vendors.defaultTopP.description": "该供应商的默认 topP,模型可单独覆盖。`0` 表示不发送 `top_p`,也是运行时默认值。仅当你需要显式控制 nucleus sampling 时再设置为正数。`anthropic` 风格请求会忽略该值,不发送 `top_p`。",
11-
"configuration.coding-plans.vendors.apiKey.description": "已废弃的供应商 API Key 配置。为保证安全,建议优先使用 Secret Storage。若此处配置了值,会覆盖 Secret Storage 中同名供应商的 key。",
12-
"configuration.coding-plans.vendors.apiKey.deprecationMessage": "已废弃:建议优先使用 Secret Storage,避免将 API Key 保存在 settings.json 中。",
11+
"configuration.coding-plans.vendors.apiKey.description": "可选的供应商 API Key 配置。为保证安全,建议优先使用 Secret Storage。若此处配置了值,会覆盖 Secret Storage 中同名供应商的 key。",
1312
"configuration.coding-plans.vendors.models.temperature.description": "模型级 temperature 覆盖项;未配置时继承供应商 defaultTemperature。",
1413
"configuration.coding-plans.vendors.models.topP.description": "模型级 topP 覆盖项;未配置时继承供应商 defaultTopP。`0` 表示不发送 `top_p`。`anthropic` 风格请求会忽略该值,不发送 `top_p`。",
1514
"providers.codingPlans.config.vendorName.title": "供应商名称(可选)",

0 commit comments

Comments
 (0)