Merge branch 'main' into cutover-test-runs

Author: JennyPng

doc/dev/sample_guide.md

@@ -54,13 +54,17 @@ The given `START`/`END` keywords can be used in a [sphinx literalinclude][sphinx
 [Literalinclude example][literalinclude]
 
 The rendered code snippets are sensitive to the indentation in the sample file. Sphinx will adjust the dedent accordingly to ensure the sample is captured accurately and not accidentally trimmed.
-You can preview how published reference documentation will look by running [tox][tox]: `tox run -e sphinx -c ../../../eng/tox/tox.ini --root <path to python package>`.
+You can preview how published reference documentation will look by running either
+- [tox][tox]: `tox run -e sphinx -c ../../../eng/tox/tox.ini --root <path to python package>`. 
+- [azpysdk](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/tool_usage_guide.md): run `azpysdk sphinx .` in the package directory.
 
 ## Test run samples in CI live tests
 Per the [Python guidelines][snippet_guidelines], sample code and snippets should be test run in CI to ensure they remain functional. Samples should be run in the package's live test pipeline which is scheduled to run daily.
 To ensure samples do get tested as part of regular CI runs, add these [lines][live_tests] to the package's tests.yml. 
 
-You can test this CI step locally first, by utilizing [tox][tox] and running `tox run -e samples -c ../../../eng/tox/tox.ini --root <path to python package>`.
+You can test this CI step locally first with tox or azpysdk:
+- To use [tox][tox], run `tox run -e samples -c ../../../eng/tox/tox.ini --root <path to python package>`. 
+- To use [azpysdk](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/tool_usage_guide.md), run `azpysdk samples .` in the package directory.
 
 The `Test Samples` step in CI will rely on the resources provisioned and environment variables used for running the package's tests.
 

doc/tool_usage_guide.md

@@ -30,6 +30,8 @@ This repo is currently migrating all checks from a slower `tox`-based framework,
 |`import_all`| Installs the package w/ default dependencies, then attempts to `import *` from the base namespace. Ensures that all imports will resolve after a base install and import. | `azpysdk import_all .` |
 |`generate`| Regenerates the code. | `azpysdk generate .` |
 |`breaking`| Checks for breaking changes. | `azpysdk breaking .` |
+|`samples`| Runs the package's samples. | `azpysdk samples .` |
+|`optional`| Invokes 'optional' requirements for a given package. | `azpysdk optional .` |
 |`devtest`| Tests a package against dependencies installed from a dev index. | `azpysdk devtest .` |
 
 ## Common arguments

eng/common/scripts/Invoke-ToolDescriptionEvaluator.ps1

@@ -8,13 +8,16 @@ steps:
   - task: PythonScript@0
     displayName: 'Run Breaking Changes'
     inputs:
-      scriptPath: 'scripts/devops_tasks/dispatch_tox.py'
+      scriptPath: 'eng/scripts/dispatch_checks.py'
       arguments: >-
         "$(TargetingString)"
         --mark_arg="${{ parameters.TestMarkArgument }}"
         --service="${{ parameters.ServiceDirectory }}"
-        --toxenv="breaking"
+        --checks="breaking"
         --disable-compatibility-filter
         --disablecov
-    env: ${{ parameters.EnvVars }}
+    env:
+      TOX_PIP_IMPL: "uv"
+      VIRTUAL_ENV: ""
+      PYTHONHOME: ""
     condition: and(succeededOrFailed(), ne(variables['Skip.BreakingChanges'],'true'))

eng/pipelines/templates/steps/run_breaking_changes.yml

@@ -36,7 +36,9 @@
 from .breaking import breaking
 from .mindependency import mindependency
 from .latestdependency import latestdependency
+from .samples import samples
 from .devtest import devtest
+from .optional import optional
 
 from ci_tools.logging import configure_logging, logger
 
@@ -104,7 +106,9 @@ def build_parser() -> argparse.ArgumentParser:
     breaking().register(subparsers, [common])
     mindependency().register(subparsers, [common])
     latestdependency().register(subparsers, [common])
+    samples().register(subparsers, [common])
     devtest().register(subparsers, [common])
+    optional().register(subparsers, [common])
 
     return parser