Skip to content

Commit d1b981f

Browse files
azure-sdkmichiisaiCopilot
authored
Sync eng/common directory with azure-sdk-tools for PR 11905 (#42785)
* Updated instructions files for service label and CODEOWNERS validation * Update eng/common/instructions/azsdk-tools/validate-service-label.instructions.md Co-authored-by: Copilot <[email protected]> * Trim trailing whitespaces * Added suggested changes from previous PR --------- Co-authored-by: Michelle <[email protected]> Co-authored-by: Michelle Ma <[email protected]> Co-authored-by: Copilot <[email protected]>
1 parent 9414695 commit d1b981f

File tree

2 files changed

+41
-19
lines changed

2 files changed

+41
-19
lines changed

eng/common/instructions/azsdk-tools/validate-codeowners.instructions.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
22
mode: 'agent'
3-
tools: ['azsdk_check_service_label', 'azsdk_engsys_validate_codeowners_entry_for_service', 'azsdk_engsys_codeowner_update']
3+
tools: ['azsdk_check_service_label', 'azsdk_engsys_validate_codeowners_entry_for_service', 'azsdk_engsys_codeowner_update']
44
---
55

6-
## Goal:
6+
## Goal:
77
Validate service label and ensure at least 2 valid code owners exist for SDK repositories.
88

99
## Step 1: Validate Service Label
1010
Use `azsdk_check_service_label` to verify the service label exists:
1111
- **DoesNotExist/NotAServiceLabel**: Direct user to create valid service label first. Stop validation process until service label is created.
1212
- **Exists/InReview**: Proceed to Step 2
1313

14-
## Step 2: Validate Code Owners
14+
## Step 2: Validate Code Owners
1515
Ask user to specify SDK repository they want to validate codeowners for or detect from context.
1616

1717
Repository name mapping:
1818
- .NET/dotnet: use "azure-sdk-for-net"
19-
- Python: use "azure-sdk-for-python"
19+
- Python: use "azure-sdk-for-python"
2020
- Java: use "azure-sdk-for-java"
2121
- JavaScript: use "azure-sdk-for-js"
2222
- Go: use "azure-sdk-for-go"
@@ -28,7 +28,7 @@ Use `azsdk_engsys_validate_codeowners_entry_for_service` with either `serviceLab
2828

2929
## Step 3: Check Existing Code Owners
3030
Valid code owners must be:
31-
- PUBLIC members of Microsoft and Azure GitHub organizations
31+
- PUBLIC members of Microsoft and Azure GitHub organizations
3232
- Have write access to the SDK repository
3333

3434
**If at least 2 valid owners**: Success - optionally add or delete additional owners
@@ -41,7 +41,7 @@ When no CODEOWNERS entry exists yet:
4141
1. Ensure you have the following information
4242
- repo - **Required** - Repository name mapping:
4343
- .NET/dotnet: use "azure-sdk-for-net"
44-
- Python: use "azure-sdk-for-python"
44+
- Python: use "azure-sdk-for-python"
4545
- Java: use "azure-sdk-for-java"
4646
- JavaScript: use "azure-sdk-for-js"
4747
- Go: use "azure-sdk-for-go"
@@ -71,4 +71,4 @@ When no CODEOWNERS entry exists yet:
7171
## Requirements
7272
- **MINIMUM**: At least 2 valid code owners at all times
7373
- **NO EXCEPTIONS**: Cannot proceed with insufficient owners
74-
- **RESPONSE HANDLING**: If any exception occurs during validation or creation, ALWAYS provide documentation link [Codeowners documentation](https://eng.ms/docs/products/azure-developer-experience/develop/supporting-sdk-customers/codeowners)
74+
- **RESPONSE HANDLING**: If any exception occurs during validation or creation, ALWAYS provide documentation link [CODEOWNERS documentation](https://eng.ms/docs/products/azure-developer-experience/develop/supporting-sdk-customers/codeowners)

eng/common/instructions/azsdk-tools/validate-service-label.instructions.md

Lines changed: 34 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,53 @@
22
mode: 'agent'
33
tools: ['azsdk_check_service_label', 'azsdk_create_service_label']
44
---
5-
5+
66
## Goal
77
Validate service label exists or create new one for SDK release process.
8-
9-
## Step 1: Get Service Label
10-
Ask user for their service label. If none provided, explain that a valid service label is required for SDK release.
11-
12-
## Step 2: Validate Label
8+
9+
## Step 1: Provide Information
10+
11+
Provide the following information about the importance of service labels:
12+
13+
"Before your SDK is released, your service must have a valid service label in the Azure SDK repositories. Service labels enable automatic owner assignment and notifications across the Azure SDK ecosystem.
14+
15+
When properly configured, service labels automatically:
16+
17+
- Notify service owners when issues are filed against their SDK
18+
- Add appropriate reviewers to pull requests
19+
- Connect code changes to the right team members through CODEOWNERS integration
20+
21+
Without a valid service label, the process to identify the correct service owners for issues and code reviews becomes manual and inefficient."
22+
23+
## Step 2: Get Service Label
24+
25+
Ask user for their service label. If they don't know their service label provide guidance:
26+
27+
- Check out the [Common Labels CSV](https://github.com/Azure/azure-sdk-tools/blob/main/tools/github/data/common-labels.csv) file and look for a row whose first column contains your service's product name.
28+
29+
If they don't have a service label - go to Step 3 for new service label
30+
31+
## Step 3: Validate Label
32+
1333
Use `azsdk_check_service_label` to check status:
14-
34+
1535
- **Exists**: Success - user can proceed with next steps in SDK release process
1636
- **InReview**: Label pending approval - user can proceed (will be available once merged)
1737
- **DoesNotExist**: Go to Step 3 to create new label
1838
- **NotAServiceLabel**: Label exists but it is not a service label - go to Step 3 for new service label
19-
20-
## Step 3: Create New Service Label
39+
40+
## Step 4: Create New Service Label
41+
2142
If no valid service label exists, guide the user through creating a new one.
22-
43+
2344
1. **Check existing labels**: Search for related service labels, offer alternatives
2445
2. **Generate recommendation**: Suggest label name following guidelines:
46+
- Should match the service's official product name as described on Service Tree (e.g., "Event Hubs", "Kusto", "Cosmos", etc.)
2547
- No "Microsoft/Azure" in name
2648
- Title Case (except short prepositions)
2749
- Avoid Service Groups: Use "Communication Rooms" instead of "Communication - Rooms"
2850
- Single label per service
2951
3. **Get confirmation**: User confirms or modifies suggested name
3052
4. **Create label**: Use `azsdk_create_service_label` with confirmed name and documentation link given by user
31-
32-
Inform user they can proceed.
53+
54+
Inform user they can proceed.

0 commit comments

Comments
 (0)