Fix markdown-link-check to run properly, fix JSON parse warning in CredScan #8325
Conversation
| @@ -23,7 +23,7 @@ _Descriptions of these steps can be found in the team OneNote._ | |||
| - [ ] Update the [signed build definition](https://devdiv.visualstudio.com/DevDiv/_build?definitionId=9675) to build the new branch | |||
| - [ ] Update Roslyn Tools [config.xml](https://github.com/dotnet/roslyn-tools/blob/main/src/GitHubCreateMergePRs/config.xml) file to flow branch changes to the latest dev branch | |||
| - [ ] dotnet/roslyn-tools PR: https://github.com/dotnet/roslyn-tools/pull/❓ | |||
| - [ ] Update [Versions.props](..\..\build\import\Versions.props) (via `<ProjectSystemVersion>`) and [version.json](..\..\version.json) (via `"version"` and `"assemblyVersion"`) to match the version of VS, if needed | |||
| - [ ] Update [Versions.props](..\\..\build\import\Versions.props) (via `<ProjectSystemVersion>`) and [version.json](..\\..\version.json) (via `"version"` and `"assemblyVersion"`) to match the version of VS, if needed | |||
There was a problem hiding this comment.
There was a problem hiding this comment.
It would likely work, yes. However, I've made every local link in the repo use \. I'd have to go through and update all of them. I'll consider doing that at some point.
| @@ -1,13 +1,30 @@ | |||
| { | |||
| "ignorePatterns": [ | |||
| { | |||
| "pattern": "^https://.*\.visualstudio\.com" | |||
| "pattern": "^https:\/\/.*\\.visualstudio\\.com" | |||
There was a problem hiding this comment.
Backslash prior to the RegEx escaping backslash is required for JSON string encoding.
| "headers": { | ||
| "Accept-Encoding": "zstd, br, gzip, deflate" | ||
| } | ||
| } |
There was a problem hiding this comment.
Workaround for docs.github.com links. See: tcort/markdown-link-check#201 (comment)
| @@ -3,7 +3,7 @@ on: [push, pull_request] | |||
|
|
|||
| jobs: | |||
| markdown-link-check: | |||
| name: verify | |||
| name: markdown-link-check | |||
There was a problem hiding this comment.
Make the name match the action when viewing it in the Action menu.
MiYanni
changed the title
| - [official.yml](build\official.yml): This file is our official build pipeline that produces the signed packages (VSIX) that used for insertion into Visual Studio. | ||
| - [unit-tests.yml](build\unit-tests.yml): This file is our build pipeline used when validating pull requests into the repo from GitHub. | ||
| - [official.yml](ci\official.yml): This file is our official build pipeline that produces the signed packages (VSIX) that used for insertion into Visual Studio. | ||
| - [unit-tests.yml](ci\unit-tests.yml): This file is our build pipeline used when validating pull requests into the repo from GitHub. |
There was a problem hiding this comment.
I take it this is fixing a broken link that is now being reported as broken?
There was a problem hiding this comment.
Correct. This PR both fixed reporting broken links and fixed the links. If you look at the failed commits in this PR, you can see the runs of the GitHub action, reporting links like this one being broken. Click on the little red ❌ from the commits above to see those runs:
ghost
added this to the 
This PR fixes our
markdown-link-checkGitHub action. It has (apparently) been broken since I added it. This was caused by an improperly encodedignorePattern. These patterns are RegEx. However, the patterns also need to respect JSON string rules. The changes include:ignorePatternignorePatternsas necessary/en/or/en-us/markdown-link-checkI've added code comments on some of the changes. I can't add those comments into the file itself since JSON doesn't natively support commenting.
This issue was initially to fix a warning I saw in our CredScan runs for our compliance pipeline. These changes should also fix that warning.
The parsing issue mentioned in the warning is also the same reason the checker wasn't working before this. Ironically, the checker itself wasn't throwing a warning about it.
Microsoft Reviewers: Open in CodeFlow