Skip to content

Commit 478e83f

Browse files
authored
Update contributing docs (#8301)
1 parent 7569722 commit 478e83f

File tree

3 files changed

+14
-8
lines changed

3 files changed

+14
-8
lines changed

docs/contributing/ASPNetCore-Debugging.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ Sometimes it may be necessary to make changes in [`dotnet/aspnetcore`](https://g
99
1. Make the desired changes in `dotnet/aspnetcore`.
1010
1. `./eng/build.cmd -pack`. The `-pack` option causes the creation of NuGet packages.
1111
1. 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.
12-
1. Open `razor-tooling/NuGet.config` and add the local package sources:
12+
1. Open `razor/NuGet.config` and add the local package sources:
1313

1414
- `<add key="ASPNETCORE_SHIPPING" value="<PATH_TO_ASPNET_CORE_REPO>\artifacts\packages\Debug\Shipping\" />`
1515
- `<add key="ASPNETCORE_NONSHIPPING" value="<PATH_TO_ASPNET_CORE_REPO>\artifacts\packages\Debug\NonShipping\" />`
1616

17-
1. Open `razor-tooling/eng/Versions.props` and note the version for `MicrosoftCodeAnalysisRazorPackageVersion`. Ex. `5.0.0-rc.1.20380.7`.
17+
1. Open `razor/eng/Versions.props` and note the version for `MicrosoftCodeAnalysisRazorPackageVersion`. Ex. `5.0.0-rc.1.20380.7`.
1818
1. Do a find in `Versions.props` for the version in step 7 and replace with `x.0.0-dev`.
1919
1. Get the assembly version of the `aspnetcore` packages.
2020
1. Assembly version can be found by openning the `.dll` in `ILSpy`
@@ -24,6 +24,6 @@ Sometimes it may be necessary to make changes in [`dotnet/aspnetcore`](https://g
2424

2525
## Notes
2626

27-
- ⚠️ Ensure you do not commit the changes to `razor-tooling/NuGet.config` & `razor-tooling/eng/Versions.props`!
28-
- 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.
27+
- ⚠️ Ensure you do not commit the changes to `razor/NuGet.config` & `razor/eng/Versions.props`!
28+
- 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/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.
2929
- If you find the old packages are still being used after this change, purge the nuget cache here: `~\.nuget\packages`

docs/contributing/BuildFromSource.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,10 @@ In most cases, this is because the option _Use previews of the .NET Core SDK_ in
8585
Note, the [Visual Studio Code C# Extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) is required.
8686

8787
1. Run `Restore.cmd` on the command line.
88-
1. Launch the `razor-tooling` repo in VS Code.
88+
1. Launch the `razor` repo in VS Code.
8989
2. Open VS Code settings (`CTRL+,`) and navigate to the `Razor > Plugin: Path` setting:
9090
![image](https://user-images.githubusercontent.com/16968319/192892840-ae2b102c-a282-472f-b1f1-ef3dad671874.png)
91-
3. Set path to `C:\path_to_razor_repo\razor-tooling\artifacts\bin\Microsoft.AspNetCore.Razor.OmniSharpPlugin\Debug\net472\Microsoft.AspNetCore.Razor.OmniSharpPlugin.dll`.
91+
3. Set path to `C:\path_to_razor_repo\artifacts\bin\Microsoft.AspNetCore.Razor.OmniSharpPlugin\Debug\net472\Microsoft.AspNetCore.Razor.OmniSharpPlugin.dll`.
9292
4. Launch extension via `Run and Debug -> Run Extension`.
9393
5. Install missing assets if prompted.
9494

docs/contributing/Roslyn-Debugging.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,14 @@ Sometimes it may be necessary to make changes in [`dotnet/roslyn`](https://githu
99
3. Make the desired changes in `dotnet/roslyn`.
1010
4. `./Build.cmd -pack`. The `-pack` option causes the creation of NuGet packages.
1111
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`).
12-
6. Open `razor-tooling/NuGet.config` and add the local package source `<add key="Roslyn Local Package source" value="<PATH_TO_ROSLYN_REPO>\artifacts\packages\Debug\Release" />`.
13-
7. Open `razor-tooling/eng/Versions.props` and update all the `Tooling_*` versions to the version noted in step 5.
12+
6. Open `razor/NuGet.config` and add the local package source `<add key="Roslyn Local Package source" value="<PATH_TO_ROSLYN_REPO>\artifacts\packages\Debug\Release" />` and package source mapping
13+
```xml
14+
<packageSource key="Roslyn Local Package source">
15+
<package pattern="microsoft.*" />
16+
<package pattern="microsoft.commonlanguageserverProtocol.*" />
17+
</packageSource>
18+
```
19+
7. Open `razor/eng/Versions.props` and update `<RoslynPackageVersion>` version to the version noted in step 5.
1420

1521
## Notes
1622

0 commit comments

Comments
 (0)