Merged main

Author: allenkim0129

doc/analyze_check_versions.md

@@ -6,7 +6,7 @@ This table is to clarify the currently pinned version of tools we run in CI and
 | Tool | Current Version | Next Version | Next Version Merge Date |
 |------|-----------------|--------------|-------------------------|
 Pylint | 3.2.5 | 3.2.7 | 2025-01-13 |
-MyPy | 1.10.1 | TBD | 2025-01-13 |
-Pyright | 1.1.371 | TBD | 2025-01-13 |
+MyPy | 1.10.1 | 1.13.0 | 2025-01-13 |
+Pyright | 1.1.371 | 1.1.389 | 2025-01-13 |
 Sphinx | 7.3.7 | N/A | N/A |
 Black | 24.4.0 | N/A | N/A |

doc/eng_sys_checks.md

@@ -112,6 +112,8 @@ This is the most useful skip, but the following skip variables are also supporte
   - Omit checking that a package's dependencies are on PyPI before releasing.
 - `Skip.KeywordCheck`
   - Omit checking that a package's keywords are correctly formulated before releasing.
+- `Skip.Black`
+  - Omit checking `black` in the `analyze` job.
 
 ## The pyproject.toml
 
@@ -172,7 +174,7 @@ You can enable test logging in a pipeline by setting the queue time variable `PY
 
 `PYTEST_LOG_LEVEL=INFO`
 
-This also works locally with tox by setting the `PYTEST_LOG_LEVEL` environment variable. 
+This also works locally with tox by setting the `PYTEST_LOG_LEVEL` environment variable.
 
 Note that if you want DEBUG level logging with sensitive information unredacted in the test logs, then you still must pass `logging_enable=True` into the client(s) being used in tests.
 
@@ -237,17 +239,17 @@ fail if docstring are invalid, helping to ensure the resulting documentation wil
 
 #### Opt-in to formatting validation
 
-Make the following change to your projects `ci.yml`:
+Ensure that `black = true` is present within your `pyproject.toml`:
 
 ```yml
-extends:
-    template: ../../eng/pipelines/templates/stages/archetype-sdk-client.yml
-    parameters:
-        ...
-        ValidateFormatting: true
-        ...
+[tool.azure-sdk-build]
+...other checks enabled/disabled
+black = true
+...other checks enabled/disabled
 ```
 
+to opt into the black invocation.
+
 #### Running locally
 
 1. Go to package root directory.

eng/common/scripts/Cadl-Project-Generate.ps1

@@ -12,7 +12,7 @@ param (
 $ErrorActionPreference = "Stop"
 . $PSScriptRoot/Helpers/PSModule-Helpers.ps1
 . $PSScriptRoot/common.ps1
-Install-ModuleIfNotInstalled "powershell-yaml" "0.4.1" | Import-Module
+Install-ModuleIfNotInstalled "powershell-yaml" "0.4.7" | Import-Module
 
 function NpmInstallForProject([string]$workingDirectory) {
     Push-Location $workingDirectory

eng/common/scripts/Cadl-Project-Sync.ps1

@@ -9,7 +9,7 @@ param (
 
 $ErrorActionPreference = "Stop"
 . $PSScriptRoot/Helpers/PSModule-Helpers.ps1
-Install-ModuleIfNotInstalled "powershell-yaml" "0.4.1" | Import-Module
+Install-ModuleIfNotInstalled "powershell-yaml" "0.4.7" | Import-Module
 $sparseCheckoutFile = ".git/info/sparse-checkout"
 
 function AddSparseCheckoutPath([string]$subDirectory) {

eng/common/scripts/Helpers/ApiView-Helpers.ps1

@@ -74,6 +74,7 @@ function Process-ReviewStatusCode($statusCode, $packageName, $apiApprovalStatus,
 {
   $apiApproved = $false
   $apiApprovalDetails = "API Review is not approved for package $($packageName). Release pipeline will fail if API review is not approved for a GA version release. You can check http://aka.ms/azsdk/engsys/apireview/faq for more details on API Approval."
+  $apiApprovalDetails += " Once your API is approved, re-trigger the release pipeline again."
 
   $packageNameApproved = $false
   $packageNameApprovalDetails = ""
@@ -115,4 +116,4 @@ function Process-ReviewStatusCode($statusCode, $packageName, $apiApprovalStatus,
 
   $packageNameStatus.IsApproved = $packageNameApproved
   $packageNameStatus.Details = $packageNameApprovalDetails
-}
+}

eng/common/scripts/Helpers/Package-Helpers.ps1

@@ -80,7 +80,7 @@ function CompatibleConvertFrom-Yaml {
   $yqPresent = Get-Command 'yq' -ErrorAction SilentlyContinue
   if (-not $yqPresent) {
     . (Join-Path $PSScriptRoot PSModule-Helpers.ps1)
-    Install-ModuleIfNotInstalled -WhatIf:$false "powershell-yaml" "0.4.1" | Import-Module
+    Install-ModuleIfNotInstalled -WhatIf:$false "powershell-yaml" "0.4.7" | Import-Module
   }
 
   # Process the content (for example, you could convert from YAML here)

eng/common/scripts/TypeSpec-Project-Generate.ps1

@@ -13,7 +13,7 @@ $ErrorActionPreference = "Stop"
 . $PSScriptRoot/Helpers/PSModule-Helpers.ps1
 . $PSScriptRoot/Helpers/CommandInvocation-Helpers.ps1
 . $PSScriptRoot/common.ps1
-Install-ModuleIfNotInstalled "powershell-yaml" "0.4.1" | Import-Module
+Install-ModuleIfNotInstalled "powershell-yaml" "0.4.7" | Import-Module
 
 function NpmInstallForProject([string]$workingDirectory) {
     Push-Location $workingDirectory

eng/common/scripts/TypeSpec-Project-Process.ps1

@@ -14,7 +14,7 @@ param (
 
 . $PSScriptRoot/common.ps1
 . $PSScriptRoot/Helpers/PSModule-Helpers.ps1
-Install-ModuleIfNotInstalled "powershell-yaml" "0.4.1" | Import-Module
+Install-ModuleIfNotInstalled "powershell-yaml" "0.4.7" | Import-Module
 
 function CreateUpdate-TspLocation([System.Object]$tspConfig, [string]$TypeSpecProjectDirectory, [string]$CommitHash, [string]$repo, [string]$repoRoot, [ref]$isNewSdkProject) {
   $additionalDirs = @()
@@ -225,4 +225,4 @@ if ($SkipSyncAndGenerate -and !$isNewSdkProject) {
   }
 }
 
-return $sdkProjectFolder
+return $sdkProjectFolder

eng/common/scripts/TypeSpec-Project-Sync.ps1

@@ -11,7 +11,7 @@ param (
 
 $ErrorActionPreference = "Stop"
 . $PSScriptRoot/Helpers/PSModule-Helpers.ps1
-Install-ModuleIfNotInstalled "powershell-yaml" "0.4.1" | Import-Module
+Install-ModuleIfNotInstalled "powershell-yaml" "0.4.7" | Import-Module
 $sparseCheckoutFile = ".git/info/sparse-checkout"
 
 function AddSparseCheckoutPath([string]$subDirectory) {

eng/common/scripts/Update-DocsMsToc.ps1

@@ -55,7 +55,7 @@ param(
 . $PSScriptRoot/common.ps1
 . $PSScriptRoot/Helpers/PSModule-Helpers.ps1
 
-Install-ModuleIfNotInstalled "powershell-yaml" "0.4.1" | Import-Module
+Install-ModuleIfNotInstalled "powershell-yaml" "0.4.7" | Import-Module
 
 Set-StrictMode -Version 3