Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Tweaks to daily build guidance after feedback #22481

Merged
merged 1 commit into from
Sep 10, 2020
Merged

Tweaks to daily build guidance after feedback #22481

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 15 additions & 16 deletions docs/DailyBuilds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,41 +6,30 @@ Daily builds are created automatically whenever a new commit is merged to the `m
* Serious bugs are usually fixed and available in a new daily build within one or two days--sometimes less. The same fix will likely not make a new preview/release for weeks.
* You are able to provide feedback immediately on any change we make, which makes it more likely we will be able to take action on this feedback before the change is baked in.

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

The daily builds are not published to NuGet.org because there are way too many of them! 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 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:

```xml
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<clear />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've often wondered if we should also do this:

<disabledPackageSources>
  <clear />
</disabledPackageSources>

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That way, if they've unchecked a source in Visual Studio, it would still work on this repo.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. It would have helped people who have got stuck in the past. Is there a chance it will break people?

Copy link
Contributor

@bricelam bricelam Sep 10, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This probably makes more sense for our repo. I can't see it breaking anyone. (when paired with the clear here.)

Maybe we shouldn't reccomend adding <clear /> under packageSources since they may be using other github/myget/azdo feeds defined in their global/user config.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think at one point we wanted to make sure that NuGet.org was the last feed. I suspect that this shouldn't matter for us either, right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yeah, there was some weird behavior around it in earlier versions of NuGet. I think it was while they were transitioning to the v3 protocol, but I can't remember the details. Probably not an issue anymore.

Copy link
Contributor

@bricelam bricelam Sep 10, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, and it probably was slowing down our builds a bit hitting nuget.org for the hundreds of packages in 1.x

<add key="dotnet-eng" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-eng/nuget/v3/index.json" />
<add key="dotnet-tools" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json" />
<add key="dotnet6" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet6/nuget/v3/index.json" />
<add key="dotnet6-transport" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet6-transport/nuget/v3/index.json" />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
</packageSources>
</configuration>
```

## Which version to use

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.

### Using an explicit version

You can use your IDE to choose the latest version. For example, in Visual Studio:

![image](https://user-images.githubusercontent.com/1430078/92644977-01108780-f299-11ea-897e-bb8e9705ada7.png)

Alternately, your IDE might provide auto-completion directly in the .csproj file:

![image](https://user-images.githubusercontent.com/1430078/92645046-1d142900-f299-11ea-9e40-c2b1fe1f61c1.png)
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**.

### Using wildcards

It may be more convenient to use wildcards in project references. For example:
The easiest way to use daily builds is with wildcards in project references. For example:

```xml
<ItemGroup>
Expand All @@ -53,6 +42,16 @@ It may be more convenient to use wildcards in project references. For example:

This will cause NuGet to pull the latest daily build whenever packages are restored.

### Using an explicit version

You can use your IDE to choose the latest version. For example, in Visual Studio:

![image](https://user-images.githubusercontent.com/1430078/92644977-01108780-f299-11ea-897e-bb8e9705ada7.png)

Alternately, your IDE might provide auto-completion directly in the .csproj file:

![image](https://user-images.githubusercontent.com/1430078/92645046-1d142900-f299-11ea-9e40-c2b1fe1f61c1.png)

## What about Visual Studio and the SDK?

EF Core 5.0 targets .NET Standard 2.1. This means that:
Expand Down