envoyproxy/envoy

Create a machine-consumable lists for deprecated fields

Open

#9 842 ouverte le 27 janv. 2020

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)C++ (5 373 forks)batch import
area/configurationhelp wanted

Métriques du dépôt

Stars
 (27 997 stars)
Métriques de merge PR
 (Merge moyen 8j) (378 PRs mergées en 30 j)

Description

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?

Guide contributeur

Direction de recherche
Tout d'abord, comprenez l'interface du plugin protoc en examinant la documentation de protobuf et les exemples existants dans le dépôt Envoy (par exemple, tools/protoplasm ou similaire). Étudiez la structure des fichiers protobuf d'Envoy pour identifier les champs obsolètes. Le plugin doit produire des listes lisibles par machine (par exemple, JSON) des champs marqués comme obsolètes ou fatals par défaut. Envisagez de partir d'un modèle simple de plugin protoc et d'itérer en fonction des retours des mainteneurs.
Stack technique
cpp
Domaine
backendapitooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C++Protocol Buffers
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
45