envoyproxy/envoy

Create a machine-consumable lists for deprecated fields

Open

#9,842 建立於 2020年1月27日

在 GitHub 查看
 (4 留言) (0 反應) (0 負責人)C++ (5,373 fork)batch import
area/configurationhelp wanted

倉庫指標

Star
 (27,997 star)
PR 合併指標
 (平均合併 8天) (30 天內合併 378 個 PR)

描述

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
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
C++Protocol Buffers
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
45