envoyproxy/envoy

Create a machine-consumable lists for deprecated fields

Open

#9,842 opened on Jan 27, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/configurationhelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

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?

Contributor guide

Research direction
Study existing protoc plugins in the Envoy repo, understand how to write a protoc plugin in C++ that iterates over field descriptors and outputs deprecated/fatal field information.
Tech stack
cpp
Domain
backendapitooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Protocol Buffers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45