Azure / Azure/azure-sdk-tools

apiviewgo considers cross-module alias versions within SDK

Open
#8,698 0 comments 0 reactions 0 assignees View on GitHub
APIView bug Go
Dominant language
C#
Stars
135
Forks
260
Avg merge
1d 22h
Merged PRs (30d)
115

Description

For example, `azcore` exports types defined in `internal`. Today, when parsing `azcore`, apiviewgo parses the source code of `internal` it finds on disk next to `azcore`. This is incorrect because it ignores the `internal` version `azcore` requires--apiviewgo just parses whatever code is on the checked-out branch and can include irrelevant, pre-release `internal` API in `azcore` reviews. apiviewgo should instead parse the `internal` version specified in `azcore/go.mod`.

Contributor guide

Open the contributing guide

Research direction

Start by tracing how apiviewgo resolves the `internal` source while parsing `azcore`, then inspect `azcore/go.mod` and compare that required version with the checked-out code. Done means reviews parse the `internal` version specified by `azcore/go.mod` rather than an unrelated or pre-release version found next to it.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.