Remove deprecated config fields (proxyUrl, sslKeyPemPath, sslCertPemPath) in 3.0

未关闭
#1,545 1 条评论 1 个 reaction 已指派 1 人 在 GitHub 查看

维护者通常 1 天内回复

@re-vlad 已经在做这个了。

开始于 2026年6月29日。

评估

这个 Issue 还没有评估数据。

描述

enhancement

Summary

Remove the deprecated top-level config fields proxyUrl, sslKeyPemPath, and sslCertPemPath from the schema, types, and config loader. These fields are already flagged deprecated: true in config.schema.json and have been superseded by upstreamProxy and tls.key / tls.cert respectively.

Why defer to 3.0

Removing these fields is a breaking change: after the upgrade, the app will fail to start unless users clean up their config files. That's not acceptable inside the 2.x line, so this work should land in the next major.

Context

  • Discussed in #1514 (review thread with @jescalada).
  • The removal was briefly included in #1514 as commit c48d0bf but reverted in 4234c16 to keep #1514 non-breaking.

Scope

  • Drop proxyUrl, sslKeyPemPath, sslCertPemPath from config.schema.json.
  • Regenerate src/config/generated/config.ts.
  • Remove the legacy fallback logic in src/config/index.ts (mergeConfigurations, getProxyUrl, getTLSKeyPemPath, getTLSCertPemPath).
  • Simplify FullGitProxyConfig to plain Required<GitProxyConfig> (drop OptionalTopLevelConfigKey).
  • Update reference docs (website/docs/configuration/reference.mdx).
  • Improve the config-load error message so users hitting a removed/unknown key get a clear "this field is no longer supported, use X" instead of the current misleading "expected boolean but got X" (per @jescalada's note in #1514).

Migration for users

Deprecated field Replacement
proxyUrl upstreamProxy
sslKeyPemPath tls.key
sslCertPemPath tls.cert
主要语言
TypeScript
星标
263
派生
185
平均合并
2 天 15 小时
30 天内合并 PR
39

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

finos/git-proxy 的其他 Issue

查看 finos/git-proxy 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。