envoyproxy/envoy

Create a machine-consumable lists for deprecated fields

Open

#9.842 geöffnet am 27. Jan. 2020

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
area/configurationhelp wanted

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

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?

Contributor Guide

Research-Richtung
Verstehe zunächst die protoc Plugin Schnittstelle, indem du die protobuf Dokumentation und vorhandene Beispiele im Envoy Repository (z. B. tools/protoplasm oder Ähnliches) überprüfst. Untersuche, wie die protobuf Dateien von Envoy strukturiert sind, um veraltete Felder zu identifizieren. Das Plugin sollte maschinenlesbare Listen (z. B. JSON) von Feldern ausgeben, die als veraltet oder standardmäßig fatal gekennzeichnet sind. Erwäge, mit einer einfachen protoc Plugin Vorlage zu beginnen und basierend auf dem Feedback der Maintainer zu iterieren.
Tech Stack
cpp
Domain
backendapitooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C++Protocol Buffers
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45