envoyproxy/envoy

Create a machine-consumable lists for deprecated fields

Open

#9842 aperta il 27 gen 2020

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)C++ (5373 fork)batch import
area/configurationhelp wanted

Metriche repository

Star
 (27.997 star)
Metriche merge PR
 (Merge medio 8g) (378 PR mergiate in 30 g)

Descrizione

When minor API versions deprecate fields or mark them fatal-by-default, config needs to be updated (or overidden in the Runtime). Newly deprecated and newly fatal fields can be difficult to reliably detect.

As suggested by @htuch, could we add a protoc plugin to produce machine-consumable lists for deprecated and fatal fields to make things easier?

Guida contributor

Direzione di ricerca
Innanzitutto, comprendi l'interfaccia del plugin protoc esaminando la documentazione di protobuf e gli esempi esistenti nel repository di Envoy (ad esempio, tools/protoplasm o simili). Indaga come sono strutturati i file protobuf di Envoy per identificare i campi deprecati. Il plugin dovrebbe produrre elenchi leggibili dalla macchina (ad esempio, JSON) dei campi contrassegnati come deprecati o fatali per impostazione predefinita. Considera di iniziare da un semplice modello di plugin protoc e di iterare in base al feedback dei manutentori.
Tech stack
cpp
Dominio
backendapitooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C++Protocol Buffers
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
45