cleanup: replace FIXMEs with tracked issues

This commit is contained in:
Tianyi Cui
2026-08-08 00:04:41 +08:00
parent 698d65de2d
commit a8a12ffc23
48 changed files with 69 additions and 87 deletions

View File

@@ -2,5 +2,5 @@
# side as of the last confirmed-consistent state. Both languages carry equal authority;
# after editing either side, bring the other along and re-record with:
# pnpm run verify-translation-pairing --write packages/sdk/telemetry/README.md
README.md: 1d33915f36e0af10eedac5f9ab34f2534268a327
README.zh.md: af54cc2c78cb360d4305eeaf584c8330a0b7efa5
README.md: c9f66a2415c91b75105b0ed025470da234b2523d
README.zh.md: bfb154e4c7c017292b5479e50ff376cbb9470682

View File

@@ -14,7 +14,7 @@ Launcher-side telemetry primitives for the dsh-sdk toolchain. This is a plain li
Consent is carried by the telemetry entry in `cordis.yml`, so disabling telemetry is disabling that entry. Telemetry reports by default and is off only when a present telemetry entry is explicitly `disabled`: a missing `cordis.yml` (first `create`), an enabled entry, or a `cordis.yml` with no telemetry entry all report. `DO_NOT_TRACK`/CI always deny. The no-config and absent-entry defaults are configurable on `ConsentResolver`.
The collection endpoint is a fixed constant (`DSH_TELEMETRY_ENDPOINT`); its `.invalid` placeholder must be replaced with the real endpoint before release.
The collection endpoint is a fixed constant (`DSH_TELEMETRY_ENDPOINT`); [#1973](https://github.com/deepseek-harness/deepseek-harness/issues/1973) tracks deploying the service and replacing its fail-safe `.invalid` placeholder before release.
## Model Experience
@@ -26,5 +26,5 @@ None; this package neither assembles nor sends a provider request.
## Known Limitations and Deferred Work
- **Placeholder endpoint** — `DSH_TELEMETRY_ENDPOINT` points at `.invalid` until the real endpoint is set.
- **Placeholder endpoint** — `DSH_TELEMETRY_ENDPOINT` points at `.invalid` until the service tracked in [#1973](https://github.com/deepseek-harness/deepseek-harness/issues/1973) is ready.
- **Redaction is heuristic** — a conservative backstop, not a guarantee; secrets belong in `.env`, which is never read or reported.

View File

@@ -14,7 +14,7 @@
Consent 由 `cordis.yml` 中的 telemetry 配置项承载,因此禁用 telemetry 就是禁用该配置项。telemetry 默认上报,只有已经存在的 telemetry 配置项被显式设为 `disabled` 时才关闭:缺少 `cordis.yml`(首次 `create`)、配置项已启用,或 `cordis.yml` 中没有 telemetry 配置项时都会上报。`DO_NOT_TRACK`CI 始终拒绝。无配置与缺少配置项的默认值可以通过 `ConsentResolver` 配置。
收集端点是固定常量(`DSH_TELEMETRY_ENDPOINT`发布前必须将其 `.invalid` 占位值替换为真实端点。
收集端点是固定常量(`DSH_TELEMETRY_ENDPOINT`[#1973](https://github.com/deepseek-harness/deepseek-harness/issues/1973) 跟踪服务部署,以及发布前将作为安全兜底的 `.invalid` 占位值替换为真实端点。
## 模型体验
@@ -26,5 +26,5 @@ Consent 由 `cordis.yml` 中的 telemetry 配置项承载,因此禁用 telemet
## 已知限制与暂缓事项
- **占位端点**`DSH_TELEMETRY_ENDPOINT` 指向 `.invalid`,直到设置真实端点
- **占位端点**`DSH_TELEMETRY_ENDPOINT` 指向 `.invalid`,直至 [#1973](https://github.com/deepseek-harness/deepseek-harness/issues/1973) 跟踪的服务就绪
- **脱敏依赖启发式规则**:这只是保守后备,不是保证;密钥应存放于 `.env`,而该文件绝不会被读取或上报。

View File

@@ -16,11 +16,10 @@ import { getOrCreateAnonymousId, type AnonymousId } from './anonymous-id.ts'
import { SecretRedactor } from './secret-redactor.ts'
/**
* Placeholder collection endpoint. This is a fixed protocol constant, not a
* deployment tunable.
*
* FIXME(ccyu): replace with the real telemetry endpoint before release. The
* `.invalid` TLD guarantees delivery fails harmlessly until then.
* Fail-safe placeholder collection endpoint. The `.invalid` TLD guarantees
* delivery fails harmlessly until the service tracked in
* https://github.com/deepseek-harness/deepseek-harness/issues/1973 is ready.
* This is a fixed protocol constant, not a deployment tunable.
*/
export const DSH_TELEMETRY_ENDPOINT = 'https://telemetry.example.invalid/v1/dsh-sdk'