Add instructions for using daily builds #280
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| How to get daily builds of YARP | ||
| =============================== | ||
|
|
||
| Daily builds include the latest source code changes. They are not supported for production use and are subject to frequent changes, but we strive to make sure daily builds function correctly. | ||
|
|
||
| If you want to download the latest daily build and use it in a project, then you need to: | ||
|
|
||
| - Obtain the latest [build of the .NET Core SDK](https://github.com/dotnet/core-sdk#installers-and-binaries). | ||
| - Add a NuGet.Config to your project directory with the following content: | ||
|
|
||
| ```xml | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <configuration> | ||
| <packageSources> | ||
| <clear /> | ||
| <add key="net5" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json" /> | ||
| <add key="NuGet.org" value="https://api.nuget.org/v3/index.json" /> | ||
| </packageSources> | ||
| </configuration> | ||
| ``` | ||
|
|
||
| *NOTE: This NuGet.Config should be with your application unless you want nightly packages to potentially start being restored for other apps on the machine.* | ||
|
There was a problem hiding this comment. After this, shouldn't we add a step like the following? There was a problem hiding this comment. That's covered in the Getting Started guide. I could link to that from here. |
||
|
|
||
| Then follow the [Getting Started](https://microsoft.github.io/reverse-proxy/articles/getting_started.html) guide to set up a project and add the nuget package dependency. Note daily builds use a higher preview version than given in the docs. | ||
|
|
||
| Some features, such as new target frameworks, may require prerelease tooling builds for Visual Studio. | ||
| These are available in the [Visual Studio Preview](https://www.visualstudio.com/vs/preview/). | ||
|
|
||
| #### To debug daily builds using Visual Studio | ||
|
|
||
| * *Enable Source Link support* in Visual Studio should be enabled. | ||
| * *Enable source server support* in Visual should be enabled. | ||
| * *Enable Just My Code* should be disabled | ||
| * Under Symbols enable the *Microsoft Symbol Servers* setting. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why link to the releases page with "Try our previews"? That just gives you a zipped version of what you could have cloned from github when we snapped a release.
Why not provide instructions for using the preview from NuGet.org similar to what we're doing for the daily builds?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting point. The releases page already links to Getting Started instructions, but I've updated the releases to explicitly link to the package on nuget.org.
I should also make the first link here go to Getting Started, which includes the nuget instructions.