Skip to content

Commit 27e3645

Browse files
praveenkuttappanazure-sdk
authored andcommitted
Update instructions as per review suggestions
1 parent c3bf546 commit 27e3645

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

eng/common/instructions/azsdk-tools/typespec-to-sdk.instructions.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ As a first step, you must prompt the user to understand the intention of SDK gen
2222

2323
Generate SDK locally in cases below:
2424
- If the user wants to walk through each SDK generation step locally. This approach requires user to have the setup for each language to generate SDK locally. User can create a pull request for each language after completing all the steps in SDK generation successfully to get the generated SDK reviewed and merged.
25-
- If the user wants to troubleshoot a failed SDK generation by the pipeline.
2625
- If SDK or client.tsp customizations are needed before creating a pull request.
26+
- If the user wants to add tests, samples or any customization to the generated SDK.
2727

2828
Generate SDK using pipeline:
2929
- If the user wants to generate SDK and get a PR automatically created in Azure SDK language repositories. This approach can be followed if the user does not want to setup local environment for each language.
@@ -53,7 +53,8 @@ Follow the steps in #file:local-sdk-workflow.instructions.md to generate and bui
5353
2. Monitor pipeline status after 15 minutes and provide updates. If pipeline is in progress, inform user that it may take additional time and check the status later.
5454
3. Display generated SDK PR links when available. If pipeline fails, inform user with error details and suggest to check pipeline logs for more information.
5555
4. If SDK pull request is available for all languages, ask user to review generated SDK pull request and mark them as ready for review when they are ready to get them reviewed and merged.
56-
5. If SDK pull request was created for test purposes, inform user to close the test SDK pull request.
56+
5. Inform the user that they can checkout generated SDK pull request locally and add more tests, samples or code customizations if needed using local SDK generation tools.
57+
6. If SDK pull request was created for test purposes, inform user to close the test SDK pull request.
5758
**Success Criteria**: SDK generation pipeline initiated and SDKs generated
5859

5960
## Step: SDK release plan

0 commit comments

Comments
 (0)