Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/ARCHITECTS
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Instructions for ARCHITECTS file format:
# This file follows the CODEOWNERS pattern style. Each non-comment line maps a
# repository path pattern to the GitHub user responsible for API architecture review.

###########
# SDK
###########

# Catch all
/sdk/ @kashifkhan
3 changes: 3 additions & 0 deletions .github/skills/create-api-review-pr/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ If the user asks to create an API review PR for a new package, explain that new
3. Python 3.10 or later must be available.
4. `azpysdk` must be installed (`pip install -e ./eng/tools/azure-sdk-tools`).
5. ApiView stub generator dependencies must be installed (`pip install -r ./eng/apiview_reqs.txt`).
6. `azsdk` CLI may be needed for package work item lookup. Do not proactively check or install it before running `create_api_review_pr.py`; the script detects supported install locations and reports when installation or update is necessary.

## Information to Gather

Expand Down Expand Up @@ -47,6 +48,8 @@ Before running the script:
3. **Validate the target tag when applicable**: If the user provided a target version or tag, construct or validate the full tag as `<package-name>_<version>` and run `git tag -l "<tag>"`.
4. **Confirm the working tree is clean**: Run `git status --porcelain` and warn if there are uncommitted changes.

Do not proactively run `azsdk --help`, `azsdk package find-work-item --help`, or the `azure-sdk-mcp.ps1` installer as a validation step. If `create_api_review_pr.py` fails with an error saying the `azsdk` CLI is not found or the `package find-work-item` command is unavailable, then run `pwsh ./eng/common/mcp/azure-sdk-mcp.ps1` from the repository root to install or update it, and rerun the same `create_api_review_pr.py` command once. If the script still reports an `azsdk` error after that, stop and report the failure.

## Execution

This is a long-running operation. The script may take several minutes because it generates API surfaces for both the baseline and target, creates or reuses review branches, pushes branches, and then opens the draft PR. Do not treat quiet terminal periods during `apistub` generation as failure unless the command exits, prints an error, or waits for input.
Expand Down
Loading
Loading