Skip to content
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

Fix markdown-link-check to run properly, fix JSON parse warning in CredScan #8325

Merged
merged 8 commits into from
Jul 18, 2022
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/branch-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would / work instead?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

- [ ] In new branch: https://github.com/dotnet/project-system/blob/dev17.❓.x/build/import/Versions.props
- [ ] In `main`: https://github.com/dotnet/project-system/blob/main/build/import/Versions.props
- [ ] Clone existing release definition to insert this branch into VS (see OneNote)
Expand Down
19 changes: 18 additions & 1 deletion .github/workflows/markdown-link-check-config.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,30 @@
{
"ignorePatterns": [
{
"pattern": "^https://.*\.visualstudio\.com"
"pattern": "^https:\/\/.*\\.visualstudio\\.com"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Backslash prior to the RegEx escaping backslash is required for JSON string encoding.

},
{
"pattern": "^https:\/\/dev\\.azure\\.com"
},
{
"pattern": "^https:\/\/aka\\.ms"
},
{
"pattern": ".*❓.*"
}
],
"replacementPatterns": [
{
"pattern": "^/",
"replacement": "{{BASEURL}}/"
}
],
"httpHeaders": [
{
"urls": ["https://docs.github.com/"],
"headers": {
"Accept-Encoding": "zstd, br, gzip, deflate"
}
}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Workaround for docs.github.com links. See: tcort/markdown-link-check#201 (comment)

]
}
2 changes: 1 addition & 1 deletion .github/workflows/markdown-link-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ on: [push, pull_request]

jobs:
markdown-link-check:
name: verify
name: markdown-link-check
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make the name match the action when viewing it in the Action menu.
image

runs-on: ubuntu-latest

steps:
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The .NET Core and ASP.NET Core support policy, including supported versions can

Security issues and bugs should be reported privately to the Microsoft Security Response Center (MSRC), either by emailing [email protected] or via the portal at https://msrc.microsoft.com.
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your
original message. Further information, including the MSRC PGP key, can be found in the [MSRC Report an Issue FAQ](https://www.microsoft.com/en-us/msrc/faqs-report-an-issue).
original message. Further information, including the MSRC PGP key, can be found in the [MSRC Report an Issue FAQ](https://www.microsoft.com/msrc/faqs-report-an-issue).

Reports via MSRC may qualify for the .NET Core Bug Bounty. Details of the .NET Core Bug Bounty including terms and conditions are at [https://aka.ms/corebounty](https://aka.ms/corebounty).

Expand Down
6 changes: 3 additions & 3 deletions build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
- *Potential change*: Rename this folder to `pipelines` as part of: https://github.com/dotnet/project-system/issues/7915

#### Notable Files
- [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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I take it this is fixing a broken link that is now being reported as broken?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
image


### `import`
- This directory is highly accessed as part of the MSBuild pipeline to produce our assemblies, run tests, create packages, etc.
Expand All @@ -22,7 +22,7 @@

### `loc`
- This directory contains the **OneLocBuildSetup** project which creates the `LocProject.json` and copies language-specific XLF files to become language-neutral; both of these are required for the [OneLocBuild](https://aka.ms/OneLocBuild) process for localization.
- The **OneLocBuildSetup** project is only build and used as part of the [one-loc-build.yml](build\one-loc-build.yml) pipeline.
- The **OneLocBuildSetup** project is only build and used as part of the [one-loc-build.yml](ci\one-loc-build.yml) pipeline.
- *Potential change*: This pipeline might be combined into another pipeline as part of: https://github.com/dotnet/project-system/issues/7915

### `optprof`
Expand Down
4 changes: 2 additions & 2 deletions docs/repo/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
#### Prerequisites
- [Visual Studio 16.3 Preview 2 or higher](https://visualstudio.microsoft.com/vs/preview/)
- GitHub account
- Basic Git experience: https://try.github.io/
- Basic Git experience: https://docs.github.com/get-started/quickstart/set-up-git

All commands below are run under a [Visual Studio Developer Prompt](https://msdn.microsoft.com/en-us/library/ms229859(v=vs.150).aspx).

## Code

Contribution to this repository is via the [fork model](https://help.github.com/articles/fork-a-repo/). Contributors push changes to their own "forked" version of project-system, and then submit a pull request into it requesting those changes be merged.
Contribution to this repository is via the [fork model](https://docs.github.com/get-started/quickstart/fork-a-repo). Contributors push changes to their own "forked" version of project-system, and then submit a pull request into it requesting those changes be merged.

To get started:

Expand Down
2 changes: 1 addition & 1 deletion setup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
- This project is an SDK-style VS Extension project, creating the VSIX package defined by the `source.extension.vsixmanifest`.
- This project type is able to build via a workaround in our [Directory.Build.targets](..\Directory.Build.targets) that loads the `Microsoft.VsSDK.targets` manually.
- The assembly produced from the `.csproj` is not used.
- The assemblies from [Microsoft.VisualStudio.AppDesigner.csproj](..\src\Microsoft.VisualStudio.AppDesigner\Microsoft.VisualStudio.AppDesigner.csproj) and [Microsoft.VisualStudio.Editors.csproj](..\src\Microsoft.VisualStudio.Editors\Microsoft.VisualStudio.Editors.csproj) are included in the produced VSIX package.
- The assemblies from [Microsoft.VisualStudio.AppDesigner.csproj](..\src\Microsoft.VisualStudio.AppDesigner\Microsoft.VisualStudio.AppDesigner.vbproj) and [Microsoft.VisualStudio.Editors.csproj](..\src\Microsoft.VisualStudio.Editors\Microsoft.VisualStudio.Editors.vbproj) are included in the produced VSIX package.
- The `.vsmanproj` creates the `.vsman` manifest, which is inserted into VS as `Microsoft.VisualStudio.Editors.vsman`.

## High-level Design
Expand Down