Conversation
Agent-Logs-Url: https://github.com/Azure/azure-sdk-for-python/sessions/58ad9191-3403-490c-bf01-f78b5be1a7d4 Co-authored-by: swathipil <76007337+swathipil@users.noreply.github.com>
…d pattern Agent-Logs-Url: https://github.com/Azure/azure-sdk-for-python/sessions/58ad9191-3403-490c-bf01-f78b5be1a7d4 Co-authored-by: swathipil <76007337+swathipil@users.noreply.github.com>
…job template Agent-Logs-Url: https://github.com/Azure/azure-sdk-for-python/sessions/58ea4b8c-d40e-4246-a444-ec1856a730d3 Co-authored-by: swathipil <76007337+swathipil@users.noreply.github.com>
….py for parallel apistub Agent-Logs-Url: https://github.com/Azure/azure-sdk-for-python/sessions/6c6f2746-d045-4a0b-ba9b-14e8b8bc7cde Co-authored-by: swathipil <76007337+swathipil@users.noreply.github.com>
|
@copilot - address this error in the CI tools step, and any other foreseeable ones: |
Updated in commit ee86057. I changed the CI tools install step in the api.md regeneration job to use Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
swathipil
force-pushed
the
swathipil/add-ci-pipeline-for-api-md
branch
from
ee86057 to
8e22811
Compare
scbedd
left a comment
scbedd
left a comment
There was a problem hiding this comment.
Triggers are safe. You're using the app. Looks g2g to me.
There was a problem hiding this comment.
Pull request overview
Adds a new Azure Pipelines workflow to mass-regenerate api.md files with azpysdk apistub --md, plus the tooling changes needed for in-place markdown generation and package filtering. This fits into the repo’s engineering automation by turning APIView markdown refreshes into a repeatable CI-driven maintenance flow.
Changes:
- Added a new
regenerate-apiview-mdpipeline and job template to run APIView markdown generation and open a draft PR when changes are detected. - Updated
azpysdk apistubanddispatch_checks.pyto support--md, in-placeapi.mdoutput, package exclusions, and management-only filtering. - Extended apistub tests to cover the new markdown output-path behavior.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
eng/tools/azure-sdk-tools/tests/test_apistub.py |
Updates unit tests for new apistub --md output behavior. |
eng/tools/azure-sdk-tools/ci_tools/functions.py |
Adds an Only_management package filter. |
eng/tools/azure-sdk-tools/azpysdk/apistub.py |
Changes apistub wheel lookup and markdown generation flow. |
eng/scripts/dispatch_checks.py |
Threads new --md and exclusion options through concurrent check dispatch. |
eng/pipelines/templates/jobs/apiview-md.yml |
Adds the job that regenerates api.md, stages changes, and creates a draft PR. |
eng/pipelines/regenerate-apiview-md.yml |
Adds the top-level pipeline entrypoint and trigger configuration. |
| variables: | ||
| - template: /eng/pipelines/templates/variables/globals.yml | ||
| - name: ExcludedPackages | ||
| value: 'nspkg,azure-storage-extensions,azure-mgmt-app,azure-mgmt-videoanalyzer,azure-mgmt-changeanalysis,azure-mgmt-apimanagement' |
| # generated token JSON. The package should rename one of these types to fix this. | ||
| - task: PythonScript@0 | ||
| displayName: 'Regenerate api.md for all packages' | ||
| continueOnError: true |
| logger.info(f"Generating api.md for {package_name}") | ||
| # When no --dest-dir is given, write api.md directly into the package | ||
| # directory so it is tracked by git. When --dest-dir is provided, keep | ||
| # the existing behaviour of writing into <dest_dir>/<package_name>/. | ||
| md_output_path = package_dir if not dest_dir else out_token_path |
| # Check staging directory first (wheel built by create_package_and_install) | ||
| if staging_dir: | ||
| found_whl = find_whl(staging_dir, pkg_details.name, pkg_details.version) | ||
| if found_whl: | ||
| return os.path.join(staging_dir, found_whl) |
fixes: #45851