From e3d9cc2f95ba35153204adb522ba0aba9701d8ea Mon Sep 17 00:00:00 2001 From: Michael Yanni Date: Fri, 15 Jul 2022 15:47:18 -0700 Subject: [PATCH 1/8] Try using hex encoding for the backslash. --- .github/workflows/markdown-link-check-config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/markdown-link-check-config.json b/.github/workflows/markdown-link-check-config.json index 9fbb32782c6..17eda03c198 100644 --- a/.github/workflows/markdown-link-check-config.json +++ b/.github/workflows/markdown-link-check-config.json @@ -1,7 +1,7 @@ { "ignorePatterns": [ { - "pattern": "^https://.*\.visualstudio\.com" + "pattern": "^https://.*%5C.visualstudio%5C.com" } ], "replacementPatterns": [ From 76ce07e1e8293e3aed90f502af6136516ccae572 Mon Sep 17 00:00:00 2001 From: Michael Yanni Date: Fri, 15 Jul 2022 15:55:27 -0700 Subject: [PATCH 2/8] Trying double backslash instead of hex encoding. --- .github/workflows/markdown-link-check-config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/markdown-link-check-config.json b/.github/workflows/markdown-link-check-config.json index 17eda03c198..434b29bfd10 100644 --- a/.github/workflows/markdown-link-check-config.json +++ b/.github/workflows/markdown-link-check-config.json @@ -1,7 +1,7 @@ { "ignorePatterns": [ { - "pattern": "^https://.*%5C.visualstudio%5C.com" + "pattern": "^https://.*\\.visualstudio\\.com" } ], "replacementPatterns": [ From a7b101afae854aea566b1976b81482de576ba51c Mon Sep 17 00:00:00 2001 From: Michael Yanni Date: Fri, 15 Jul 2022 16:43:20 -0700 Subject: [PATCH 3/8] Added more ignore patterns for checker. Fixed broken links. --- .github/workflows/markdown-link-check-config.json | 11 ++++++++++- .github/workflows/markdown-link-check.yml | 2 +- build/README.md | 6 +++--- docs/repo/getting-started.md | 4 ++-- setup/README.md | 2 +- 5 files changed, 17 insertions(+), 8 deletions(-) diff --git a/.github/workflows/markdown-link-check-config.json b/.github/workflows/markdown-link-check-config.json index 434b29bfd10..073571c13b9 100644 --- a/.github/workflows/markdown-link-check-config.json +++ b/.github/workflows/markdown-link-check-config.json @@ -1,7 +1,16 @@ { "ignorePatterns": [ { - "pattern": "^https://.*\\.visualstudio\\.com" + "pattern": "^https:\/\/.*\\.visualstudio\\.com" + }, + { + "pattern": "^https:\/\/dev\\.azure\\.com" + }, + { + "pattern": "^https:\/\/aka\\.ms" + }, + { + "pattern": ".*❓.*" } ], "replacementPatterns": [ diff --git a/.github/workflows/markdown-link-check.yml b/.github/workflows/markdown-link-check.yml index 9220a131c7c..b4fa8b48f5b 100644 --- a/.github/workflows/markdown-link-check.yml +++ b/.github/workflows/markdown-link-check.yml @@ -11,7 +11,7 @@ jobs: uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - name: Validate Markdown links - uses: gaurav-nelson/github-action-markdown-link-check@9710f0fec812ce0a3b98bef4c9d842fc1f39d976 + uses: gaurav-nelson/github-action-markdown-link-check@96dcdf3b1aa465b550d137c8ffa957b37e71e80c with: use-quiet-mode: 'yes' # https://github.com/tcort/markdown-link-check#config-file-format diff --git a/build/README.md b/build/README.md index 1b828b9e966..0ac6f7a2e71 100644 --- a/build/README.md +++ b/build/README.md @@ -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. ### `import` - This directory is highly accessed as part of the MSBuild pipeline to produce our assemblies, run tests, create packages, etc. @@ -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` diff --git a/docs/repo/getting-started.md b/docs/repo/getting-started.md index 18a62767d7d..017e217bda5 100644 --- a/docs/repo/getting-started.md +++ b/docs/repo/getting-started.md @@ -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/en/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/en/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: diff --git a/setup/README.md b/setup/README.md index bbe5050abb5..5537a74cba8 100644 --- a/setup/README.md +++ b/setup/README.md @@ -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 From c34e2496d7d3b7293869875eb750981c5cfcdad7 Mon Sep 17 00:00:00 2001 From: Michael Yanni Date: Fri, 15 Jul 2022 16:49:06 -0700 Subject: [PATCH 4/8] Make the markdown checker name as markdown-link-check. --- .github/workflows/markdown-link-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/markdown-link-check.yml b/.github/workflows/markdown-link-check.yml index b4fa8b48f5b..995bcfefce4 100644 --- a/.github/workflows/markdown-link-check.yml +++ b/.github/workflows/markdown-link-check.yml @@ -3,7 +3,7 @@ on: [push, pull_request] jobs: markdown-link-check: - name: verify + name: markdown-link-check runs-on: ubuntu-latest steps: From 2ccd8e25ee7e813578cc62eadcf77ef0c99d841c Mon Sep 17 00:00:00 2001 From: Michael Yanni Date: Fri, 15 Jul 2022 16:56:54 -0700 Subject: [PATCH 5/8] Change version back since there is no newer stable version. --- .github/workflows/markdown-link-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/markdown-link-check.yml b/.github/workflows/markdown-link-check.yml index 995bcfefce4..e8b94e38f17 100644 --- a/.github/workflows/markdown-link-check.yml +++ b/.github/workflows/markdown-link-check.yml @@ -11,7 +11,7 @@ jobs: uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - name: Validate Markdown links - uses: gaurav-nelson/github-action-markdown-link-check@96dcdf3b1aa465b550d137c8ffa957b37e71e80c + uses: gaurav-nelson/github-action-markdown-link-check@9710f0fec812ce0a3b98bef4c9d842fc1f39d976 with: use-quiet-mode: 'yes' # https://github.com/tcort/markdown-link-check#config-file-format From b069979dfb15e2a6209592bd6cdc16eddc663bcf Mon Sep 17 00:00:00 2001 From: Michael Yanni Date: Fri, 15 Jul 2022 17:03:49 -0700 Subject: [PATCH 6/8] More link fixes. --- .github/ISSUE_TEMPLATE/branch-checklist.md | 2 +- .github/workflows/markdown-link-check-config.json | 8 ++++++++ docs/repo/getting-started.md | 4 ++-- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/branch-checklist.md b/.github/ISSUE_TEMPLATE/branch-checklist.md index 1902eb4c567..27194eb0200 100644 --- a/.github/ISSUE_TEMPLATE/branch-checklist.md +++ b/.github/ISSUE_TEMPLATE/branch-checklist.md @@ -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 ``) 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 ``) and [version.json](\..\..\version.json) (via `"version"` and `"assemblyVersion"`) to match the version of VS, if needed - [ ] 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) diff --git a/.github/workflows/markdown-link-check-config.json b/.github/workflows/markdown-link-check-config.json index 073571c13b9..7bca20d220e 100644 --- a/.github/workflows/markdown-link-check-config.json +++ b/.github/workflows/markdown-link-check-config.json @@ -18,5 +18,13 @@ "pattern": "^/", "replacement": "{{BASEURL}}/" } + ], + "httpHeaders": [ + { + "urls": ["https://docs.github.com/"], + "headers": { + "Accept-Encoding": "zstd, br, gzip, deflate" + } + } ] } diff --git a/docs/repo/getting-started.md b/docs/repo/getting-started.md index 017e217bda5..a5503f0b3ec 100644 --- a/docs/repo/getting-started.md +++ b/docs/repo/getting-started.md @@ -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://docs.github.com/en/get-started/quickstart/set-up-git +- 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://docs.github.com/en/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. +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: From 2370f886586acda637e1207e5a1cbaae7dd0b00e Mon Sep 17 00:00:00 2001 From: Michael Yanni Date: Fri, 15 Jul 2022 17:18:31 -0700 Subject: [PATCH 7/8] Trying to resolve relative path URL problems. --- .github/ISSUE_TEMPLATE/branch-checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/branch-checklist.md b/.github/ISSUE_TEMPLATE/branch-checklist.md index 27194eb0200..ba2aed8f02b 100644 --- a/.github/ISSUE_TEMPLATE/branch-checklist.md +++ b/.github/ISSUE_TEMPLATE/branch-checklist.md @@ -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 ``) 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 ``) and [version.json](..\\..\version.json) (via `"version"` and `"assemblyVersion"`) to match the version of VS, if needed - [ ] 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) From 16afa2730597dad40f1e1396e1b0e1477a641595 Mon Sep 17 00:00:00 2001 From: Michael Yanni Date: Fri, 15 Jul 2022 17:28:02 -0700 Subject: [PATCH 8/8] Remove language from link. --- SECURITY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SECURITY.md b/SECURITY.md index 030ac0c0657..fc26b6dcc74 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -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 secure@microsoft.com 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).