In case "default" CI job for your PR failed, click "Details" and analyze, messages there are usually helpful.
Find and open msbuild.err from build artifacts to see summarized error message. List of possible failures is below.
To get even more detailed data click "Console Output" and look for keywords like "Fail", etc.
c:\workspace\powershell\build.proj(278,5): error MSB3073: The command ""C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe" -NonInteractive -NoLogo -NoProfile -Command "$ProgressPreference = 'SilentlyContinue';. c:\workspace\powershell\tools\GenerateHelp.ps1 -ValidateMarkdownHelp -GenerateMamlHelp -BuildConfig Debug -FilteredModules 'Az.Network;Az.Profile' "" exited with code -1.
This means there are issues with your help files.
- Cmdlet was changed while .md help files were not regenerated this way or there is no help files at all.
- Help files were re-generated, however they weren't filled with real data. I.e. help generator leaves templates like this
"{{Description there}}"
and they need to be manually filled by developer with descriptions, examples, etc.
Regenerate MD help files this way and update "{{*}}" placeholders
Online version in the header of the file is incorrect.
This means the online version url in the header of the help document is either incorrect or missing.
The url should exactly match the schema https://learn.microsoft.com/en-us/powershell/module/az.{modulename}/{cmdlet-name}
, all in lower case.
https://learn.microsoft.com/en-us/powershell/module/az.keyvault/new-azkeyvault
c:\workspace\powershell\build.proj(597,5): error MSB3073: The command "c:\workspace\powershell\artifacts\StaticAnalysis.exe -p c:\workspace\powershell\artifacts\Debug -r c:\workspace\powershell\artifacts -m Az.Network" exited with code 255.c:\workspace\powershell\build.proj(609,5): error : StaticAnalysis has failed. Please follow the instructions on this doc: https://github.com/Azure/azure-powershell/blob/main/documentation/Debugging-StaticAnalysis-Errors.md
Something that is considered as unacceptable was added with your PR e.g. breaking change, incorrect signature, etc.
According to the link above you would need to investigate .csv files in the build artifacts.
There are several ways to act:
-
In case your changes in the listed files are unintentional, just roll them back.
-
In case changes could be improved without affecting functionality (e.g. signature is incorrect, but you could adjust it to suit requirements), try to fix.
-
In case messages in csv files describe expected changes, add them to exclusions.
One of the often reasons are BreakingChangesIssues.
If collected Breaking Changes issues are expected (e.g. cmdlet was really changed), you would need to update Exclusions file like this to bypass CI build.
Test failures occurred, check the files in artifacts/Test
One or more tests failed
See test reports in artifacts/Test and fix failures related to your changes.
In case you see more failures, please contact test owning team. Common way is to find a person who edited the cmdlet or test last. Networking tests are also marked with header like this to simplify team search: [Trait(Category.Owner, Category.TeamAlias)]
Exception:System.IO.FileNotFoundException: The specified module 'D:\a\1\s\artifacts\Debug\Az.Network\Az.Network.psd1' was not loaded because no valid module file was found in any module directory.
This is because your test cases are using cmdlets from other module, but it was not built by CI.
Add the missing module's csproj to your module's .sln file. For example this is how Compute.sln
references Network.csproj
:
https://github.com/Azure/azure-powershell/blob/58ded2ba3e0a5f7da0d1ffed9e0adb986986ab6f/src/Compute/Compute.sln#L11