envoyproxy/envoy

Create a machine-consumable lists for deprecated fields

Open

#9,842 opened on 2020年1月27日

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
 (平均マージ 8d) (30d で 378 merged PRs)

説明

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?

コントリビューターガイド

調査方針
まず、protobuf ドキュメントと Envoy リポジトリ内の既存の例（例: tools/protoplasm または類似のもの）を確認して、protoc プラグインインターフェースを理解します。Envoy の protobuf ファイルの構造を調査し、非推奨フィールドを特定します。プラグインは、非推奨またはデフォルトで致命的とマークされたフィールドの機械可読なリスト（例: JSON）を出力する必要があります。単純な protoc プラグインテンプレートから始め、メンテナのフィードバックに基づいて反復的に改善することを検討してください。
技術スタック
cpp
領域
backendapitooling
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
C++Protocol Buffers
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
45