Skip to content

Commit ecd74d3

Browse files
scbeddCopilot
andauthored
Clean up eng_sys_docs.md (#46332)
* a solid refactor of the eng sys checks * manually adjust the platform support matrix * address copilot PR review comments - fix 'preprequisites' typo in check_change_log README - fix malformed double-pipe table row for PIP_INDEX_URL/UV_DEFAULT_INDEX - fix malformed 5-separator for 2-column platform matrix table - update MyPy and Pylint descriptions: runs on Python 3.10, not 3.9 - update Static Analysis section intro to acknowledge verifywhl/verifysdist build artifacts - add warning about apistub Python < 3.11 constraint to analyze_python_version note - fix stale anchor links in CONTRIBUTING.md to match current section names Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * address Mccoy's feedback * bump requirements for alignment --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 3448dcf commit ecd74d3

5 files changed

Lines changed: 336 additions & 209 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,15 @@ SDK performance testing is supported via the custom `perfstress` framework. For
9595

9696
### More Reading
9797

98-
We maintain an [additional document](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md) that has a ton of detail as to what is actually _happening_ in these executions.
98+
We maintain an [additional document](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md) that has a ton of detail as to what is actually _happening_ in these executions. That document covers:
99+
100+
- [Static analysis checks](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#static-analysis-checks) (MyPy, Pyright, Pylint, Sphinx, Bandit, etc.)
101+
- [Install and test checks](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#install-and-test-checks) (whl, sdist, mindependency, latestdependency, devtest, regression)
102+
- [PR validation](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#pr-validation) (subset that runs on every pull request)
103+
- [Nightly and release checks](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#nightly-and-release) (full check set including latestdependency, whl_no_aio, import_all)
104+
- [Weekly analyze checks](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#weekly-analyze-checks) (ruff, next-generation tool versions)
105+
- [pyproject.toml configuration](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#the-pyprojecttoml) (enabling/disabling checks per package, analyze_python_version override)
106+
- [Skipping checks at queue time](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#skipping-checks-at-queue-time)
99107

100108
### Dev Feed
101109
Daily dev build version of Azure sdk packages for python are available and are uploaded to Azure devops feed daily. Below is the link to Azure devops feed.

doc/dev/mgmt/generation.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ PS C:\dev\azure-sdk-for-python> .\.venv\Scripts\Activate.ps1 # Windows
5757
3. Install Python dependencies:
5858
```
5959
(.venv) PS C:\dev\azure-sdk-for-python> python .\scripts\dev_setup.py -p azure-core
60-
(.venv) PS C:\dev\azure-sdk-for-python> pip install tox
6160
(.venv) PS C:\dev\azure-sdk-for-python> pip install setuptools
6261
```
6362

0 commit comments

Comments
 (0)