From b0b810421f507166a1f6c315a7779da29bae178a Mon Sep 17 00:00:00 2001 From: Allison Chou Date: Wed, 1 Dec 2021 21:05:39 -0800 Subject: [PATCH] Update tooling docs (#5805) --- .github/ISSUE_TEMPLATE/config.yml | 4 ++-- CONTRIBUTING.md | 3 ++- docs/contributing/ASPNetCore-Debugging.md | 8 ++++---- docs/contributing/BuildFromSource.md | 12 ++++++------ docs/contributing/Roslyn-Debugging.md | 4 ++-- 5 files changed, 16 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 30461f1f8a..ec2626a928 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: true contact_links: - name: Issue with Razor compiler - url: https://github.com/dotnet/aspnetcore/issues/new/choose - about: Please open issues relating to the Razor compiler in dotnet/aspnetcore. + url: https://github.com/dotnet/razor-compiler/issues/new/choose + about: Please open issues relating to the Razor compiler in dotnet/razor-compiler. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0330880bae..3460ff74b9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,8 @@ Security issues and bugs should be reported privately, via email, to the Microso ## Other issues For non-Razor tooling related bugs, please log a new issue in the appropriate GitHub repo. Here are some of the most common repos: -* [ASP.NET Core (runtime and Razor compiler)](https://github.com/dotnet/aspnetcore) +* [Razor compiler](https://github.com/dotnet/razor-compiler) +* [ASP.NET Core (runtime)](https://github.com/dotnet/aspnetcore) * [Docs](https://github.com/aspnet/Docs) * [Entity Framework Core](https://github.com/dotnet/efcore) * [Extensions](https://github.com/dotnet/extensions) diff --git a/docs/contributing/ASPNetCore-Debugging.md b/docs/contributing/ASPNetCore-Debugging.md index 658f07ae4f..70530fa2a0 100644 --- a/docs/contributing/ASPNetCore-Debugging.md +++ b/docs/contributing/ASPNetCore-Debugging.md @@ -7,11 +7,11 @@ Sometimes it may be necessary to make changes in [`dotnet/aspnetcore`](https://g 3. Make the desired changes in `dotnet/aspnetcore`. 4. `./eng/build.cmd -pack`. The `-pack` option causes the creation of NuGet packages. 5. You should see the generated packages in the `aspnetcore\artifacts\packages\Debug\NonShipping` directory. The packages should end with `x.0.0-dev.nupkg` where `x` is the current .NET version. -6. Open `aspnetcore-tooling/NuGet.config` and add the local package sources: +6. Open `razor-tooling/NuGet.config` and add the local package sources: - `` - `` -7. Open `aspnetcore-tooling/eng/Versions.props` and note the version for `MicrosoftCodeAnalysisRazorPackageVersion`. Ex. `5.0.0-rc.1.20380.7`. +7. Open `razor-tooling/eng/Versions.props` and note the version for `MicrosoftCodeAnalysisRazorPackageVersion`. Ex. `5.0.0-rc.1.20380.7`. 8. Do a find in `Versions.props` for the version in step 7 and replace with `x.0.0-dev`. 9. Get the assembly version of the `aspnetcore` packages. 1. Assembly version can be found by openning the `.dll` in `ILSpy` @@ -20,6 +20,6 @@ Sometimes it may be necessary to make changes in [`dotnet/aspnetcore`](https://g 10. Update the `OldVersionUpperBound` and `NewVersion`, of the Razor assemblies in `src\Razor\src\Microsoft.VisualStudio.RazorExtension\AssemblyBindingRedirects.cs` with the assembly version from the step above. ## Notes: -- ⚠️ Ensure you do not commit the changes to `aspnetcore-tooling/NuGet.config` & `aspnetcore-tooling/eng/Versions.props`! -- If you're still seeing build errors after performing the above steps, you may have to temporarily modify `OldVersionUpperBound` and `NewVersion` of the first five assemblies in [AssemblyBindingRedirects.cs](https://github.com/dotnet/aspnetcore-tooling/blob/main/src/Razor/src/Microsoft.VisualStudio.RazorExtension/AssemblyBindingRedirects.cs) to match the assembly version of the aspnetcore packages above. You can find the assembly version by opening one of the packages with [ILSpy](https://github.com/icsharpcode/ILSpy/releases) or similar tool. +- ⚠️ Ensure you do not commit the changes to `razor-tooling/NuGet.config` & `razor-tooling/eng/Versions.props`! +- If you're still seeing build errors after performing the above steps, you may have to temporarily modify `OldVersionUpperBound` and `NewVersion` of the first five assemblies in [AssemblyBindingRedirects.cs](https://github.com/dotnet/razor-tooling/blob/main/src/Razor/src/Microsoft.VisualStudio.RazorExtension/AssemblyBindingRedirects.cs) to match the assembly version of the aspnetcore packages above. You can find the assembly version by opening one of the packages with [ILSpy](https://github.com/icsharpcode/ILSpy/releases) or similar tool. - If you find the old packages are still being used after this change, purge the nuget cache here: `~\.nuget\packages` diff --git a/docs/contributing/BuildFromSource.md b/docs/contributing/BuildFromSource.md index d8130e0dcd..528e2f967e 100644 --- a/docs/contributing/BuildFromSource.md +++ b/docs/contributing/BuildFromSource.md @@ -1,22 +1,22 @@ -# Build ASP.NET Core Tooling from Source +# Build Razor Tooling from Source -Building ASP.NET Core Tooling from source allows you to tweak and customize the Razor tooling experience for ASP.NET Core, and to contribute your improvements back to the project. +Building Razor Tooling from source allows you to tweak and customize the Razor tooling experience for ASP.NET Core, and to contribute your improvements back to the project. -See for known issues and to track ongoing work. +See for known issues and to track ongoing work. ## Clone the source code For a new copy of the project, run: ```ps1 -git clone https://github.com/dotnet/aspnetcore-tooling.git +git clone https://github.com/dotnet/razor-tooling.git ``` ## Install pre-requisites ### Windows -Building ASP.NET Core Tooling on Windows requires: +Building Razor Tooling on Windows requires: * Windows 10, version 1803 or newer * At least 10 GB of disk space and a good internet connection (our build scripts download a lot of tools and dependencies) @@ -27,7 +27,7 @@ Building ASP.NET Core Tooling on Windows requires: ### macOS/Linux -Building ASP.NET Core on macOS or Linux requires: +Building Razor Tooling on macOS or Linux requires: * If using macOS, you need macOS Sierra or newer. * If using Linux, you need a machine with all .NET Core Linux prerequisites: diff --git a/docs/contributing/Roslyn-Debugging.md b/docs/contributing/Roslyn-Debugging.md index 6e8d015183..65ca16eb37 100644 --- a/docs/contributing/Roslyn-Debugging.md +++ b/docs/contributing/Roslyn-Debugging.md @@ -7,8 +7,8 @@ Sometimes it may be necessary to make changes in [`dotnet/roslyn`](https://githu 3. Make the desired changes in `dotnet/roslyn`. 4. `./Build.cmd -pack`. The `-pack` option causes the creation of NuGet packages. 5. You should see the generated packages in the `roslyn\artifacts\packages\Debug\Release` directory. Take note of the package versions (ie. `Microsoft.CodeAnalysis.Workspaces.Common.3.8.0.nupkg` => `3.8.0`). -6. Open `aspnetcore-tooling/NuGet.config` and add the local package source ``. -7. Open `aspnetcore-tooling/eng/Versions.props` and update all the `Tooling_*` versions to the version noted in step 5. +6. Open `razor-tooling/NuGet.config` and add the local package source ``. +7. Open `razor-tooling/eng/Versions.props` and update all the `Tooling_*` versions to the version noted in step 5. ## Notes: - If you're familiar with _Visual Studio Hives_ the `dotnet/roslyn` project uses the `RoslynDev` root suffix .