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
+14-12Lines changed: 14 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,14 +12,7 @@ Follow these steps in order to create or manage a release plan for an API specif
12
12
- If no pull request is available, prompt the user to provide the API spec pull request link
13
13
- Validate that the provided pull request link is accessible and valid
14
14
15
-
## Step 2: Check Existing Release Plan
16
-
- Use `azsdk_get_release_plan_for_spec_pr` to check if a release plan already exists for the API spec pull request
17
-
- If a release plan exists:
18
-
- Display the existing release plan details to the user
19
-
- Skip to Step 5 (Link SDK Pull Requests)
20
-
- If no release plan exists, proceed to Step 3
21
-
22
-
## Step 3: Gather Release Plan Information
15
+
## Step 2: Gather Release Plan Information
23
16
Collect the following required information from the user. Do not create a release plan with temporary values. Confirm the values with the user before proceeding to create the release plan.
24
17
If any details are missing, prompt the user accordingly:
25
18
@@ -31,25 +24,34 @@ If any details are missing, prompt the user accordingly:
31
24
- "beta" for preview API versions
32
25
- "stable" for GA API versions
33
26
34
-
## Step 4: Create Release Plan
27
+
## Step 3: Create Release Plan
35
28
- If the user doesn't know the required details, direct them to create a release plan using the release planner
36
29
- Provide this resource: [Release Plan Creation Guide](https://eng.ms/docs/products/azure-developer-experience/plan/release-plan-create)
37
30
- Once all information is gathered, use `azsdk_create_release_plan` to create the release plan
31
+
- If existing release plans are found, follow the instructions under Step 3a - Handle Existing Release Plans
38
32
- Display the newly created release plan details to the user for confirmation
39
33
- Refer to #file:sdk-details-in-release-plan.instructions.md to identify languages configured in the TypeSpec project and add them to the release plan
40
34
41
-
## Step 5: Update SDK Details in Release Plan
35
+
### Step 3a: Handle Existing Release Plans
36
+
- When `azsdk_create_release_plan` returns existing release plans.
37
+
- Extract and display key information: Release Plan ID, status, associated languages, SDK PRs
38
+
- Present the three options:
39
+
1.**Work with the existing release plan** - Use the current release plan and make any needed updates
40
+
2.**Force create a new release plan** - Create a completely new release plan even though one already exists
41
+
3.**Cancel** - Don't proceed with release plan creation
42
+
43
+
## Step 4: Update SDK Details in Release Plan
42
44
- Refer to #file:sdk-details-in-release-plan.instructions.md to add languages and package names to the release plan
43
45
- If the TypeSpec project is for a management plane, refer to #file:verify-namespace-approval.instructions.md if this is first release of SDK.
44
46
45
-
## Step 6: Link SDK Pull Requests (if applicable)
47
+
## Step 5: Link SDK Pull Requests (if applicable)
46
48
- Ask the user if they have already created SDK pull requests locally for any programming language
47
49
- If SDK pull requests exist:
48
50
- Collect the pull request links from the user
49
51
- Use `azsdk_link_sdk_pull_request_to_release_plan` to link each SDK pull request to the release plan
50
52
- Confirm successful linking for each SDK pull request
0 commit comments