apache / apache/pinot

Public API checker before release

Open
#5,843 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
6.1k
Forks
1.5k
Avg merge
1d 21h
Merged PRs (30d)
189

Description

It will be good to have a checker to scan the breaks on the APIs marked as `Public` and `Stable` as part of the release process.

For example, this [diff](https://github.com/apache/incubator-pinot/pull/5309/files#diff-24ff51adc8972c5974229e92a180cd71R46) changed some public API, and breaks other implementation of `StreamMessageDecoder`.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the referenced PR 5309 diff and the StreamMessageDecoder API change to understand the reported break. Then identify how Java APIs marked Public and Stable are represented and where release checks run. Done means the release process detects incompatible changes to those APIs.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.