envoyproxy/envoy

api_compat support for work_in_progress annotations

Open

#18,228 opened on Sep 23, 2021

View on GitHub
 (0 comments) (0 reactions) (1 assignee)C++ (5,373 forks)batch import
apiarea/cibughelp wanted

Repository metrics

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

Description

Title: api_compat support for work_in_progress annotations

Description: #18218 introduced the work_in_progress annotations for API files, messages, and fields. The api breaking compatibility change needs to ignore any breaking changes to these objects. Note that this mainly impacts CI.

This issue is to track progress on the needed adjustments for the tool.

Contributor guide

Research direction
Examine the existing breaking change detection in api compat and add logic to ignore work in progress annotations.
Tech stack
cpp
Domain
apici cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Mostly clear
Prerequisites
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50