Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jun 24, 2025

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

  • Updated to require Python 3.9+ and Node.js 20.x LTS+ as specified in wiki
  • Added tsp-client CLI tool installation requirement: npm install -g @azure-tools/typespec-client-generator-cli
  • Enhanced environment verification steps

📁 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")
  • Clear folder structure patterns with examples

⚙️ TypeSpec Configuration

Enhanced tspconfig.yaml guidance with proper structure:

parameters:
  "service-dir":
    default: "YOUR-SERVICE-DIRECTORY"
emit: ["@azure-tools/typespec-autorest"]
options:
  "@azure-tools/typespec-python":
    package-dir: "YOUR-PACKAGE-DIR"
    namespace: "YOUR.NAMESPACE.NAME"
    flavor: "azure"

🚀 TSP-Client Workflow Integration

Updated SDK generation commands to match wiki specifications:

  • Initial setup: tsp-client init -c <REMOTE_TSPCONFIG_URL> from repo root
  • Updates: tsp-client update from SDK folder with tsp-location.yaml
  • Proper URL formatting with commit hashes (not branch names)

✅ Enhanced Validation Workflow

Reordered validation steps for better developer experience:

  1. Code formatting (black) → 2. Linting (pylint) → 3. Type checking (mypy/pyright) → 4. Documentation (sphinx) → 5. Security & samples

📚 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
    • Triggering command: 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.

@Copilot Copilot AI changed the title [WIP] [test] Improve dev workflow [dev] Improve TypeSpec SDK generation workflow to align with codegen wiki guidelines Jun 24, 2025
@Copilot Copilot AI requested a review from l0lawrence June 24, 2025 21:30
Copilot finished work on behalf of l0lawrence June 24, 2025 21:30
Copy link

Hi @copilot. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[test] Improve dev workflow
2 participants