|
2 | 2 | mode: 'agent' |
3 | 3 | tools: ['azsdk_check_service_label', 'azsdk_create_service_label'] |
4 | 4 | --- |
5 | | - |
| 5 | + |
6 | 6 | ## Goal |
7 | 7 | 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 | + |
13 | 33 | Use `azsdk_check_service_label` to check status: |
14 | | - |
| 34 | + |
15 | 35 | - **Exists**: Success - user can proceed with next steps in SDK release process |
16 | 36 | - **InReview**: Label pending approval - user can proceed (will be available once merged) |
17 | 37 | - **DoesNotExist**: Go to Step 3 to create new label |
18 | 38 | - **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 | + |
21 | 42 | If no valid service label exists, guide the user through creating a new one. |
22 | | - |
| 43 | + |
23 | 44 | 1. **Check existing labels**: Search for related service labels, offer alternatives |
24 | 45 | 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.) |
25 | 47 | - No "Microsoft/Azure" in name |
26 | 48 | - Title Case (except short prepositions) |
27 | 49 | - Avoid Service Groups: Use "Communication Rooms" instead of "Communication - Rooms" |
28 | 50 | - Single label per service |
29 | 51 | 3. **Get confirmation**: User confirms or modifies suggested name |
30 | 52 | 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