Sync eng/common directory with azure-sdk-tools for PR 11839 (#6717)
* snake case * change file name to .instructions.md * Revert "change file name to .instructions.md" This reverts commit c4bb65dc03258a45f74590edff6ccbf889d9e559. --------- Co-authored-by: Juan Ospina <70209456+jeo02@users.noreply.github.com>
This commit is contained in:
parent
c62e0dc059
commit
9eec2d0ced
@ -15,7 +15,7 @@ Check the release readiness of an SDK package by collecting the required informa
|
||||
- Go
|
||||
|
||||
2. **Execute Readiness Check**:
|
||||
- Use the `CheckPackageReleaseReadiness` tool with the provided package name and selected language
|
||||
- Use the `azsdk_check_package_release_readiness` tool with the provided package name and selected language
|
||||
- Do not check for existing pull requests to run this step.
|
||||
- Do not ask the user to create a release plan to run this step.
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ Follow these steps in order to create or manage a release plan for an API specif
|
||||
- Validate that the provided pull request link is accessible and valid
|
||||
|
||||
## Step 2: Check Existing Release Plan
|
||||
- Use `GetReleasePlanForPullRequest` to check if a release plan already exists for the API spec pull request
|
||||
- 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)
|
||||
@ -33,7 +33,7 @@ If any details are missing, prompt the user accordingly:
|
||||
## Step 4: 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 `CreateReleasePlan` to create the release plan
|
||||
- Once all information is gathered, use `azsdk_create_release_plan` to create the release plan
|
||||
- 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
|
||||
|
||||
@ -45,7 +45,7 @@ If any details are missing, prompt the user accordingly:
|
||||
- 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 `LinkSdkPullRequestToReleasePlan` to link each SDK pull request to the release plan
|
||||
- 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
|
||||
|
||||
@ -34,6 +34,6 @@ description: 'Identify languages configured in the TypeSpec project and add it t
|
||||
|
||||
# Step 3: Update Release Plan with SDK Information
|
||||
**Goal**: Update the release plan with the languages and package names identified in Step 1.
|
||||
1. Use `UpdateReleasePlanSDKInfo` to update the release plan work item with the JSON object created in Step 1.
|
||||
1. Use `azsdk_update_sdk_details_in_release_plan` to update the release plan work item with the JSON object created in Step 1.
|
||||
2. Confirm successful update of the release plan with the SDK information and summary of languages and package names.
|
||||
**Success Criteria**: Release plan updated with languages and package names.
|
||||
@ -26,17 +26,17 @@ Your goal is to guide user through the process of generating SDKs from TypeSpec
|
||||
## Step 3: Verify Authentication and Repository Status
|
||||
**Goal**: Ensure user is authenticated and working in correct repository
|
||||
**Actions**:
|
||||
1. Run `GetGitHubUserDetails` to verify login status
|
||||
1. Run `azsdk_get_github_user_details` to verify login status
|
||||
2. If not logged in, prompt: "Please login to GitHub using `gh auth login`"
|
||||
3. Once logged in, display user details to confirm identity
|
||||
4. Run `CheckIfSpecInPublicRepo` to verify repository
|
||||
4. Run `azsdk_check_typespec_project_in_public_repo` to verify repository
|
||||
5. If not in public repo, inform: "Please make spec changes in Azure/azure-rest-api-specs public repo to generate SDKs"
|
||||
**Success Criteria**: User authenticated and working in public Azure repo
|
||||
|
||||
## Step 4: Review and Commit Changes
|
||||
**Goal**: Stage and commit TypeSpec modifications
|
||||
**Actions**:
|
||||
1. Run `GetModifiedTypeSpecProjects` to identify changes
|
||||
1. Run `azsdk_get_modified_typespec_projects` to identify changes
|
||||
2. If no changes found, inform: "No TypeSpec projects were modified in current branch"
|
||||
3. Display all modified files (excluding `.github` and `.vscode` folders)
|
||||
4. Prompt user: "Please review the modified files. Do you want to commit these changes? (yes/no)"
|
||||
@ -63,7 +63,7 @@ Your goal is to guide user through the process of generating SDKs from TypeSpec
|
||||
## Step 6: Create Specification Pull Request
|
||||
**Goal**: Create PR for TypeSpec changes if not already created
|
||||
**Actions**:
|
||||
1. Check if spec PR already exists using `GetPullRequestForCurrentBranch`
|
||||
1. Check if spec PR already exists using `azsdk_get_pull_request_link_for_current_branch`
|
||||
2. If PR exists, display PR details and proceed to Step 7
|
||||
3. If no PR exists:
|
||||
- Refer to #file:create-spec-pullrequest.instructions.md
|
||||
@ -86,7 +86,7 @@ Your goal is to guide user through the process of generating SDKs from TypeSpec
|
||||
## Step 8: Show Generated SDK PRs
|
||||
**Goal**: Display all created SDK pull requests
|
||||
**Actions**:
|
||||
1. Run `GetSDKPullRequestDetails` to fetch generated SDK PR info.
|
||||
1. Run `azsdk_get_sdk_pull_request_link` to fetch generated SDK PR info.
|
||||
|
||||
## Step 9: Validate Label and Codeowners
|
||||
**Goal**: Validate the label and all codeowners for a service. Create new label and codeowner entry if none exist.
|
||||
|
||||
@ -17,6 +17,6 @@ check if they want to link a different namespace approval issue to the release p
|
||||
**Goal**: Link namespace approval issue to the release plan.
|
||||
**Actions**:
|
||||
1. Collect GitHub issue created in Azure/azure-sdk repo for namespace approval. Do not use any other repo name.
|
||||
2. Run `LinkNameSpaceApprovalIssue` to link the issue to the release plan work item id.
|
||||
2. Run `azsdk_link_namespace_approval_issue` to link the issue to the release plan work item id.
|
||||
3. Confirm successful linking of the namespace approval issue to the release plan.
|
||||
**Success Criteria**: Namespace approval issue linked to the release plan or confirmed as already linked.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user