Azure / Azure/azure-sdk-tools

Add apiview even when ApiCompat detects an issue

Open
#6,016 0 comments 0 reactions 0 assignees View on GitHub
.NET APIView
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

It is much easier to analyze the public api diff in apiview but when dotnet ApiCompat detects an error [like this](https://github.com/Azure/azure-sdk-for-net/pull/34959/checks?check_run_id=12898347690) we don't get an apiview. We should be able to build without apicompat so that we can get an artifact to upload to apiview so that looking at this diff is easier.

Contributor guide

Open the contributing guide

Research direction

Start by locating the build path where dotnet ApiCompat reports an error and the apiview artifact is produced. Trace how an ApiCompat failure prevents the artifact from being uploaded, then verify that the build still produces an apiview diff when ApiCompat detects an issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
build-system, devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.