You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: eng/common/instructions/azsdk-tools/create-release-plan.instructions.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,10 +29,9 @@ If any details are missing, prompt the user accordingly:
29
29
-**Service Tree ID**: GUID format identifier for the service in Service Tree. Before creating release plan, always show the value to user and ask them to confirm it's a valid value in service tree.
30
30
-**Product Service Tree ID**: GUID format identifier for the product in Service Tree. Before creating release plan, always show the value to user and ask them to confirm it's a valid value in service tree.
31
31
-**Expected Release Timeline**: Format must be in "Month YYYY"
32
-
-**API Version**: The version of the API being released
33
32
-**SDK Release Type**: Value must be beta or stable.
34
-
- "beta" for preview API versions
35
-
- "stable" for GA API versions
33
+
- "beta"
34
+
- "stable"
36
35
37
36
## Step 4: Create Release Plan
38
37
- If the user doesn't know the required details, direct them to create a release plan using the release planner
description: 'Identify languages configured in the TypeSpec project and add it to release plan'
2
+
description: 'Update SDK details in a release plan from a TypeSpec project'
3
3
---
4
-
# Step 1: Find the list of languages and package names
5
-
**Goal**: Identify languages configured in the TypeSpec project and generate the json object with language and package name.
6
-
1. Identify the language emitter configuration in the `tspconfig.yaml` file in the TypeSpec project root.
7
-
2. Identify the package name or namespace for each language emitter.
8
-
- For Java and Python, use `emitter-output-dir` for package name if it exists. Otherwise use `package-dir` to get the package name as fallback approach.
9
-
- For .NET, use namespace property to get package name.
10
-
- For JavaScript, use `packagedetails:name` property to get package name.
11
-
- For Go, use module name and remove `github.com/Azure/azure-sdk-for-go/` to get package name.
12
-
3. Map the language name in emitter to one of the following in Pascal case(except .NET):
13
-
- .NET
14
-
- Java
15
-
- Python
16
-
- JavaScript
17
-
- Go
18
-
4. Create a JSON array object with the following structure:
19
-
```json
20
-
[
21
-
{
22
-
"language": "<LanguageName>",
23
-
"packageName": "<PackageName>"
24
-
},
25
-
...
26
-
]
27
-
```
28
-
5. If no languages are configured, inform the user: "No languages configured in TypeSpec project. Please add at least one language emitter in tspconfig.yaml."
29
-
**Success Criteria**: JSON object with languages and package names created.
4
+
# Step 1: Identify the TypeSpec project path
5
+
**Goal**: Identify the path to the TypeSpec project that contains the `tspconfig.yaml` file.
6
+
1. Identify the TypeSpec project directory that contains a `tspconfig.yaml` file.
7
+
2. If a TypeSpec project path is not provided or known, ask the user for the path.
8
+
3. If no `tspconfig.yaml` exists at the given path, inform the user: "No tspconfig.yaml found at the given path. Please provide a valid TypeSpec project path."
**Goal**: Determine if a release plan exists for the API spec pull request or work item Id or release plan Id in current context.
@@ -36,17 +16,7 @@ description: 'Identify languages configured in the TypeSpec project and add it t
36
16
**Success Criteria**: Release plan exists or user informed to create one.
37
17
38
18
# Step 3: Update Release Plan with SDK Information
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.**
40
-
> -**JavaScript**: Must start with `@azure/`
41
-
> -**Go**: Must start with `sdk/`
42
-
>
43
-
> **Valid package name examples (compare against these to catch invalid formats):**
0 commit comments