Skip to content

Sync eng/common directory with azure-sdk-tools for PR 12516 #53588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Sync eng/common directory with azure-sdk-tools for PR 12516 #53588

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d302b2
Allow forced creation when release plans already exist
smw-ms Oct 15, 2025
c7799a9
Update creation instructions
smw-ms Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 11 additions & 16 deletions eng/common/instructions/azsdk-tools/create-release-plan.instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
> **Important Note for LLM**
> Backend processes may use Azure DevOps work item data as needed. However, do **not** mention or display the work item link/URL, or any reference to Azure DevOps work item resources directly in conversation with the user.
> All manual updates to an existing release plan must be made through the [Release Planner Tool](https://aka.ms/sdk-release-planner) to ensure proper tracking and validation.
> Only provide release plan details such as **Release Plan Link** and **Release Plan ID** to the user
> **CRITICAL INSTRUCTIONS FOR LLM***
Copy link

Copilot AI Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra asterisk at the end of 'LLM'. Should be 'CRITICAL INSTRUCTIONS FOR LLM' with matching double asterisks on both sides for proper markdown formatting.

Suggested change
> **CRITICAL INSTRUCTIONS FOR LLM***
> **CRITICAL INSTRUCTIONS FOR LLM**

Copilot uses AI. Check for mistakes.
> 1. Backend processes may use Azure DevOps work item data as needed. However, do **not** mention or display the work item link/URL, or any reference to Azure DevOps work item resources directly in conversation with the user.
> 2. All manual updates to an existing release plan must be made through the [Release Planner Tool](https://aka.ms/sdk-release-planner) to ensure proper tracking and validation.
> 3. Only provide release plan details such as **Release Plan Link** and **Release Plan ID** to the user
> 4. Always check the `NextSteps` field in the tool response and follow any additional prompts provided. Do NOT proceed to other steps until the NextSteps are completed.

# Release Plan Creation Process
Your goal is to create a valid release plan. You must prompt user to provide all required information and all input must match the format and requirement mentioned in step 3 below.
Copy link

Copilot AI Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reference to 'step 3 below' is outdated. After the restructuring, the relevant step is now 'Step 2: Gather Release Plan Information' (line 16), not Step 3.

Suggested change
Your goal is to create a valid release plan. You must prompt user to provide all required information and all input must match the format and requirement mentioned in step 3 below.
Your goal is to create a valid release plan. You must prompt user to provide all required information and all input must match the format and requirement mentioned in Step 2: Gather Release Plan Information below.

Copilot uses AI. Check for mistakes.
Expand All @@ -12,14 +13,7 @@ Follow these steps in order to create or manage a release plan for an API specif
- If no pull request is available, prompt the user to provide the API spec pull request link
- Validate that the provided pull request link is accessible and valid

## Step 2: Check Existing Release Plan
- Use `azsdk_get_release_plan_for_spec_pr` to check if a release plan already exists for the API spec pull request
- If a release plan exists:
- Display the existing release plan details to the user
- Skip to Step 5 (Link SDK Pull Requests)
- If no release plan exists, proceed to Step 3

## Step 3: Gather Release Plan Information
## Step 2: Gather Release Plan Information
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.
If any details are missing, prompt the user accordingly:

Expand All @@ -31,25 +25,26 @@ If any details are missing, prompt the user accordingly:
- "beta" for preview API versions
- "stable" for GA API versions

## Step 4: Create Release Plan
## Step 3: Create Release Plan
- If the user doesn't know the required details, direct them to create a release plan using the release planner
- Provide this resource: [Release Plan Creation Guide](https://eng.ms/docs/products/azure-developer-experience/plan/release-plan-create)
- Once all information is gathered, use `azsdk_create_release_plan` to create the release plan
- If existing release plans are found, extract and display key information: Release Plan ID, status, associated languages, SDK PRs
- Display the newly created release plan details to the user for confirmation
- 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

## Step 5: Update SDK Details in Release Plan
## Step 4: Update SDK Details in Release Plan
- Refer to #file:sdk-details-in-release-plan.instructions.md to add languages and package names to the release plan
- If the TypeSpec project is for a management plane, refer to #file:verify-namespace-approval.instructions.md if this is first release of SDK.

## Step 6: Link SDK Pull Requests (if applicable)
## Step 5: Link SDK Pull Requests (if applicable)
- Ask the user if they have already created SDK pull requests locally for any programming language
- If SDK pull requests exist:
- Collect the pull request links from the user
- Use `azsdk_link_sdk_pull_request_to_release_plan` to link each SDK pull request to the release plan
- Confirm successful linking for each SDK pull request

## Step 7: Summary
## Step 6: Summary
- Display a summary of the completed actions:
- Release plan status (created or existing)
- Linked SDK pull requests (if any)
Expand Down