[FEATURE] Deprecation-manifest codegen target that emits changelog fragments in diff mode

Aperta
  • Qualcosa non va?
#677 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@sethfitz ci sta già lavorando.

Dal 19/8/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

enhancement

Sub-issue of #639 — surface 3 of 3 ("What flows where"), automatic path. Stretch.

Depends on #674 for the extraction carrier and on #675 for the deprecation fragment type.

Scope

Detect when a deprecation is introduced, so nobody has to remember to write the fragment.

A codegen deprecation-manifest target emits a small structured list of every deprecated element — field path or model name, plus its message. Think of it as a generation target simpler than the Markdown reference: same extraction input, a summary instead of a document.

Run in diff mode against the last released tag, the target compares that manifest to the current one and emits each newly-appeared entry directly as a deprecation fragment. Detection and scaffolding fold into the one target, and the fragment body is the message already authored on the annotation — nothing is written twice.

Open questions

  • Is manifest-plus-diff the right mechanism, or does a simpler check over the diff of the models themselves do the job?
  • Where does diff mode run — a release-time tool, or a CI check on every PR that fails when a new deprecation ships without a fragment? The second catches the omission when it is cheap to fix.
  • What is the manifest's stable identity for a field, given fields move between models? A qualified path is the obvious answer and needs confirming against the union/arm cases.

Acceptance

  • The manifest target emits one entry per deprecated field and model, with its message.
  • Diff mode against a tag with no deprecations emits a fragment per deprecated element; against the current HEAD it emits nothing.
  • A deprecation removed between releases does not emit a fragment.

Integration points

  • A new codegen output format alongside markdown, reading the same FieldSpec.deprecated / model-spec carrier from #674.
  • Fragments land in the affected package's changelog.d/ as <pr>.deprecation.md.
Lingua principale
Python
Stelle
219
Fork
21
Merge medio
4g 9h
PR unite (30g)
18

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 OvertureMaps/schema

Tutte le issue di OvertureMaps/schema

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.