Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 20, 2025

This PR creates a comprehensive documentation table of all tox checks currently used in the Azure SDK for Python repository. This documentation serves as a critical reference for the tox migration effort outlined in issue #42601.

What's included

The documentation provides a complete table with 27 tox environments, including:

  • Check Name: The exact tox environment name
  • CLI Command: The full command line syntax to run each check
  • Script(s) Called: The specific Python scripts executed by each environment
  • How It Works: Detailed explanation of what each check does

Key insights discovered

During the analysis, several important patterns were identified that will be crucial for the migration:

  1. Common Infrastructure: Most checks rely on shared scripts like create_package_and_install.py for package building
  2. Tool Versioning: Each tool is pinned to specific versions for consistency (e.g., pylint 3.2.7, mypy 1.14.1)
  3. Environment Isolation: Each check uses unique proxy URLs for process isolation
  4. Dependency Categories: Clear patterns emerge around base deps, packaging tools, and specialized dependencies

Check categories identified

The 27 checks fall into logical categories:

  • Code Quality & Linting (6 checks): pylint, ruff, black, bandit, etc.
  • Type Checking (4 checks): mypy, pyright, verifytypes variants
  • Testing & Package Validation (7 checks): whl, sdist, samples, verification
  • Dependency Management (4 checks): dependency compatibility testing
  • Documentation & API (4 checks): sphinx, API review tools
  • Utilities (2 checks): code generation and optional validations

Migration readiness

This documentation directly maps to the migration checklist in #42601, providing the detailed technical information needed to implement each check in the new dispatch_check system. Each entry includes the exact commands and scripts that need to be replicated outside of tox.

The table will serve as a living document during the migration, with checks marked as completed as they are successfully migrated to the new system.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@l0lawrence l0lawrence closed this Aug 20, 2025
@Copilot Copilot AI changed the title [WIP] help me make an issue that is a subissue to #42601 that will have a table that has the name of each tox check, the cli command for that check, what script that check calls, how the check works Add comprehensive tox checks documentation table as reference for migration effort Aug 20, 2025
Copilot finished work on behalf of l0lawrence August 20, 2025 21:38
@Copilot Copilot AI requested a review from l0lawrence August 20, 2025 21:38
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.

2 participants