From fc0b8be0112c4c3e505e9f7dec839c5a0c7e7a90 Mon Sep 17 00:00:00 2001 From: Arthur Vickers Date: Mon, 14 Sep 2020 13:26:24 -0700 Subject: [PATCH 1/2] Updates to daily build guidance for EF Core 5.0/EF Core 6.0 Also changed the guidance around clearing package sources. --- docs/DailyBuilds.md | 83 ++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 75 insertions(+), 8 deletions(-) diff --git a/docs/DailyBuilds.md b/docs/DailyBuilds.md index 33aab8acb29..2f91b41a8db 100644 --- a/docs/DailyBuilds.md +++ b/docs/DailyBuilds.md @@ -8,28 +8,47 @@ Daily builds are created automatically whenever a new commit is merged to the `m A disadvantage of using daily builds is that there can be significant API churn for new features. However, this should only be an issue if you're trying out new features as they are being developed. -## Using daily builds +## Package sources -The daily builds are not published to NuGet.org because the .NET build infrastructure is not set up for this. Instead they can be pulled from a custom NuGet feed. To access this feed, create a `NuGet.config` file in the same directory as your .NET solution or projects. The file should contain the following content: +The daily builds are not published to NuGet.org because the .NET build infrastructure is not set up for this. Instead they can be pulled from a custom NuGet package source. To access this custom source, create a `NuGet.config` file in the same directory as your .NET solution or projects. + +There are two different NuGet package sources for daily builds as we transition from EF Core 5.0 to EF Core 6.0. + +### Package source for EF Core 5.0 + +Note that a feature complete release candidate with a go-live license is [available now on NuGet](https://www.nuget.org/packages/Microsoft.EntityFrameworkCore/5.0.0-rc.1.20451.13). Daily builds are only needed for early access to the RC2 bits. + +For EF Core 5.0 RC2 daily builds, `NuGet.config` should contain: ```xml - - + ``` -## Which version to use +### Package source for EF Core 6.0 + +For EF Core 6.0 daily builds, `NuGet.config` should contain: + +```xml + + + + + + + +``` -Daily builds are currently branded as EF Core 6.0. For example, `6.0.0-alpha.1.20457.2`. This is an artifact of the build system; **these builds still contain the bits what we plan to ship as EF Core 5.0**. +## Package versions to use ### Using wildcards -The easiest way to use daily builds is with wildcards in project references. For example: +The easiest way to use daily builds is with wildcards in project references. For example, for EF Core 6.0 daily builds: ```xml @@ -40,7 +59,18 @@ The easiest way to use daily builds is with wildcards in project references. For ``` -This will cause NuGet to pull the latest daily build whenever packages are restored. +Or for EF Core 5.0 RC2 daily builds: + +```xml + + + + + + +``` + +Using wildcards will cause NuGet to pull the latest daily build whenever packages are restored. ### Using an explicit version @@ -60,3 +90,40 @@ EF Core 5.0 targets .NET Standard 2.1. This means that: * The daily builds should work with any IDE that supports .NET Core 3.1. * They do not require a Visual Studio preview release, although previews will also work. * The daily builds should work with either the .NET Core 3.1 SDK or the .NET 5 SDK installed. + +## Troubleshooting + +### Missing packages + +The config files shown above contain the two NuGet package sources needed for EF Core and its dependencies. However, you may need to add additional package sources for daily builds of other projects, or your own internal packages. + +In addition, packages may be missing if the standard `nuget.org` package source has been disabled elsewhere; adding the source in this config will not bring it back. To fix this, either don't disable `nuget.org` anywhere, or tell NuGet to ignore previously disabled sources: + +```xml + + + + + + + + + + +``` + +A good way to ensure you're dealing with a completely clean NuGet configuration is to clear both disabled package sources _and_ previously configured package sources. For example: + +```xml + + + + + + + + + + + +``` From 293ec217d46f8fa82448b00d399fd8c4a63b1f47 Mon Sep 17 00:00:00 2001 From: Arthur Vickers Date: Fri, 18 Sep 2020 12:12:56 -0700 Subject: [PATCH 2/2] Update docs/DailyBuilds.md Co-authored-by: Shay Rojansky --- docs/DailyBuilds.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DailyBuilds.md b/docs/DailyBuilds.md index 2f91b41a8db..82d5343e924 100644 --- a/docs/DailyBuilds.md +++ b/docs/DailyBuilds.md @@ -24,7 +24,7 @@ For EF Core 5.0 RC2 daily builds, `NuGet.config` should contain: - +