[dev] Improve TypeSpec SDK generation workflow to align with codegen wiki guidelines #41747
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the dev workflow by reformatting the copilot instructions file to better showcase the codegen wiki guidelines flow as referenced in the Dataplane Codegen Quick Start.
Key Improvements
🔧 Prerequisites Alignment
npm install -g @azure-tools/typespec-client-generator-cli
📁 Project Structure Guidance
Added comprehensive guidance following wiki conventions:
service_name
: Matches azure-rest-api-specs folder (e.g., "servicebus")namespace
: Python import path (e.g., "azure.servicebus")package_name
: PyPI name (e.g., "azure-servicebus")⚙️ TypeSpec Configuration
Enhanced tspconfig.yaml guidance with proper structure:
🚀 TSP-Client Workflow Integration
Updated SDK generation commands to match wiki specifications:
tsp-client init -c <REMOTE_TSPCONFIG_URL>
from repo roottsp-client update
from SDK folder with tsp-location.yaml✅ Enhanced Validation Workflow
Reordered validation steps for better developer experience:
📚 Comprehensive Documentation References
Added direct links to key resources:
Before/After Comparison
Before: Instructions focused on internal MCP tools with limited wiki alignment
After: Step-by-step workflow directly following the official codegen wiki guidelines
The copilot instructions now provide clear, standardized guidance that ensures developers follow established best practices and maintain consistency across SDK generation projects.
Fixes #41746.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
azure.github.io
curl -s -I REDACTED
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.