chore: Remove the decline_responses_websockets translation after a deprecation release

Aperta
#1,625 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
55/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
go
Ambito
backend

Direzione di ricerca

First confirm that a release has shipped the warning and that the project is ready for a breaking change. Then inspect core/config/config.go and core/config/validate.go, and review the history of #1467 for the earlier refusal. Update TestLoad_DeprecatedDeclineKeyStillApplies into a refusal test and remove the old-key references from the three named docs; done means the old key is refused with a message naming its replacement mode and the release notes mark the change as breaking.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

What

v0.9.4 shipped listener.decline_responses_websockets, a boolean. #1467 replaces it with listener.responses_websockets: parse | decline | forward. To keep v0.9.4 configs working, #1467 still reads the old key when the new one is unset (true → decline, false → forward), logs a WARN naming the new key, and refuses a config that sets both.

This issue tracks removing that translation.

When

Not before both of these:

  • At least one release has shipped the warning. A user who set the old key should have had a release that told them to change it before one that refuses it.
  • A release the project is willing to label a breaking change. Before 1.0, semver allows a breaking change in any release, and this repo has done it: #1429 shipped in v0.9.2, a patch release, listed under "Breaking changes" in its notes. So this does not have to wait for 1.0, but it needs a deliberate release-notes entry, not a silent removal.

What removal means

Do not delete the field outright. If the field were simply deleted, the YAML would ignore the key, and a config that set decline_responses_websockets: false would quietly get the default, parse, with no word said. Replace the translation with a startup refusal that names the mode the old value maps to. That refusal is what #1467 did before v0.9.4 shipped the key, and it is in that PR's history.

  • core/config/config.go: DeclineResponsesWebSockets and the fallback in ResponsesWebSocketsMode.
  • core/config/validate.go: the WARN and the both-set refusal become a single refusal.
  • TestLoad_DeprecatedDeclineKeyStillApplies becomes a refusal test.
  • Docs: docs/agents/codex.md, docs/framework-architecture.md and CLAUDE.md describe the old key; drop those lines.

PR title prefix: Breaking change:, so the release notes say so.

Lingua principale
Go
Stelle
23
Fork
44
Merge medio
16h 37m
PR unite (30g)
250

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di rossoctl/cortex

Tutte le issue di rossoctl/cortex

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.