create-api-review-pr
Installation
SKILL.md
Create API Review PR
Creates a dedicated API review PR that shows the diff between a baseline release and a target tag or branch's API surface using scripts/api_md_workflow/create_api_review_pr.py.
Unsupported Requests
If the user asks to create an API review PR for a new package, explain that new packages do not use API review PRs and stop. Do not gather script inputs or run create_api_review_pr.py for new packages.
Prerequisites
- The user must have
ghCLI installed and authenticated (gh auth login), orGITHUB_TOKEN/GH_TOKENset with permission to create and update pull requests in this repository. - The working tree must be clean (no uncommitted changes).
- Python 3.10 or later must be available.
azpysdkmust be installed (pip install -e ./eng/tools/azure-sdk-tools).- ApiView stub generator dependencies must be installed (
pip install -r ./eng/apiview_reqs.txt). azsdkCLI may be needed for package work item lookup. Do not proactively check or install it before runningcreate_api_review_pr.py; the script detects supported install locations and reports when installation or update is necessary.