Skip to content

Fix broken links in troubleshoot-ci.md #10210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 9, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions documentation/troubleshoot-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,40 +16,40 @@ This means there are issues with your help files.

### Reasons:

- Cmdlet was changed while .md help files were not regenerated [this way](documentation/development-docs/help-generation.md) or there is no help files at all.
- Cmdlet was changed while .md help files were not regenerated [this way](development-docs/help-generation.md) 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.

### Solution

Regenerate MD help files [this way](documentation/development-docs/help-generation.md) and update "{{\*}}" placeholders
Regenerate MD help files [this way](development-docs/help-generation.md) and update "{{\*}}" placeholders

## Code analysis failures

### Message

> 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/master/documentation/Debugging-StaticAnalysis-Errors.md](documentation/Debugging-StaticAnalysis-Errors.md)
> 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/master/documentation/Debugging-StaticAnalysis-Errors.md](Debugging-StaticAnalysis-Errors.md)

### Reasons

Something that is considered as unacceptable was added with your PR e.g. breaking change, incorrect signature, etc.

### Solution

According to the [link above](documentation/Debugging-StaticAnalysis-Errors.md) you would need to investigate .csv files in the build artifacts.
According to the [link above](Debugging-StaticAnalysis-Errors.md) you would need to investigate .csv files in the build artifacts.

There are several ways to act:

1. In case your changes in the listed files are unintentional, just roll them back.

2. 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.

3. In case messages in csv files describe expected changes, add them to [exclusions](documentation/Debugging-StaticAnalysis-Errors.md#breaking-changes).
3. In case messages in csv files describe expected changes, add them to [exclusions](Debugging-StaticAnalysis-Errors.md#breaking-changes).

### Example:

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](documentation/Debugging-StaticAnalysis-Errors.md#breaking-changes) to bypass CI build.
If collected Breaking Changes issues are expected (e.g. cmdlet was really changed), you would need to update Exclusions file [like this](Debugging-StaticAnalysis-Errors.md#breaking-changes) to bypass CI build.

## Test failures

Expand Down