Add aiohttp to apiview requirements to fix API.md consistency check#47544
Open
EldertGrootenboer wants to merge 5 commits into
Open
Add aiohttp to apiview requirements to fix API.md consistency check#47544EldertGrootenboer wants to merge 5 commits into
EldertGrootenboer wants to merge 5 commits into
Conversation
Co-authored-by: EldertGrootenboer <19503614+EldertGrootenboer@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds aiohttp to the API.md consistency (apiview stub generation) requirements so packages that import AioHttpTransport can be imported successfully during stub generation in CI.
Changes:
- Add a pinned
aiohttpdependency toeng/apiview_reqs.txtused by the API.md consistency workflow.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The API.md Consistency check (
apistub/apiview-stub-generator) builds the API stub by importing the whole package. Forazure-servicebus, importingazure.servicebus.aio.management._management_client_asynceagerly importsAioHttpTransportfromazure.core.pipeline.transport, which requiresaiohttp. The apiview requirements environment did not includeaiohttp, so stub generation failed with:This made the
consistencycheck fail on anyazure-servicebusPR (and any other package whose import graph reachesAioHttpTransport), blocking merges.Fix
Add
aiohttptoeng/apiview_reqs.txtso the API.md consistency environment can import packages that reference the aiohttp-based transport.Notes
Extracted from #45142 so this engineering-environment fix lands independently of the feature change.