Azure / Azure/azure-sdk-tools

APIView: baseline revision was incorrect, requiring an API approval for a feature that had already shipped

Open
#10,253 0 comments 0 reactions 0 assignees View on GitHub
needs-triage
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

I recently had an issue where APIView was incorrectly flagging a new release as containing an API change.

The problem, as @chidozieononiwu appears to have diagnosed, is that the baseline revision in APIView had been generated from the wrong revision.

Here's the baseline, which appears to be based on an older version of the code than what's actually in 1.8.0: https://spa.apiview.dev/review/0579bbe5a2324f17a48f1a2bca2ff383?activeApiRevisionId=868bd2a67e9641a3bad83fb66cde2dc4

Specifically, it's missing the feature we actually did release: CustomEndpoint. You can see this in the Go package website: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/messaging/azservicebus#ClientOptions

Contributor guide

Open the contributing guide

Research direction

Start by reviewing APIView's baseline revision generation and the linked APIView review, then compare the baseline with the 1.8.0 Go package documentation, especially CustomEndpoint. Done means APIView uses the correct shipped revision and does not require approval for the already-released feature.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, go
Domain
api, release
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.