Skip to content

Commit 4128096

Browse files
smw-msazure-sdk
authored andcommitted
Add examples
1 parent 7133fd3 commit 4128096

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

eng/common/instructions/azsdk-tools/sdk-details-in-release-plan.instructions.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,16 @@ description: 'Identify languages configured in the TypeSpec project and add it t
3636
**Success Criteria**: Release plan exists or user informed to create one.
3737

3838
# Step 3: Update Release Plan with SDK Information
39-
> **(MANDATORY - DO NOT SKIP) ALWAYS validate all package names against the format rules before calling any update tool, even if the user provides SDK details directly. Auto-correct and inform the user of invalid package names.**
39+
> **(MANDATORY - DO NOT SKIP) ALWAYS validate all package names against the format rules AND the examples table before calling any update tool, even if the user provides SDK details directly. Auto-correct and inform the user of invalid package names.**
4040
> - **JavaScript**: Must start with `@azure/`
4141
> - **Go**: Must start with `sdk/`
42+
>
43+
> **Valid package name examples (compare against these to catch invalid formats):**
44+
> | Language | Valid | Invalid |
45+
> |----------|-------|---------|
46+
> | JavaScript | `@azure/arm-compute` | `arm-compute`, `azure/arm-compute`,`@azure-arm-compute` |
47+
> | Go (management plane) | `sdk/resourcemanager/compute/armcompute` | `sdk/armcompute`, `/sdk/compute`, `github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute` |
48+
4249
**Goal**: Update the release plan with the languages and package names identified in Step 1.
4350
1. Use `azsdk_update_sdk_details_in_release_plan` to update the release plan work item with the JSON object created in Step 1.
4451
2. Confirm successful update of the release plan with the SDK information and summary of languages and package names.

0 commit comments

Comments
 (0)