Skip to content

Add Nightly Build feed to README.md#34241

Merged
jkotas merged 4 commits intodotnet:masterfrom
FreddyDgh:doc-nightly
Mar 28, 2020
Merged

Add Nightly Build feed to README.md#34241
jkotas merged 4 commits intodotnet:masterfrom
FreddyDgh:doc-nightly

Conversation

@FreddyDgh
Copy link
Copy Markdown
Contributor

When a PR is merged that fixes an issue, the question is often raised as to how/when library consumers can use the fixed code. The answer often states that we can download the latest version from the nightly NuGet package feed, but it is currently very difficult to locate the feed to use. Furthermore, I don't think many Microsoft employees know the URL of the nightly feed, or at least they don't know what feed to tell the public. This PR updates the home page for the repo with a link to the proper feed to make it easily discoverable for end users.

Some considerations:

  1. Need to verify that this is actually the best feed URL to use.
  2. Perhaps the full URL should be visible so that it can be copy/pasted without clicking the link, as that is what many people will do with it. Hiding the full URL behind link text makes the home page look cleaner, but also means people have to click the link (or right click to copy the link).

This PR has been submitted at the request of @danmosemsft.

@jkotas
Copy link
Copy Markdown
Member

jkotas commented Mar 28, 2020

https://github.com/dotnet/runtime/blob/master/docs/project/dogfooding.md has the detailed instructions for how to consume the nightly builds. I think that the readme should just have a link to this page.

This page has oudated NuGet feeds. They should be updated.

Comment thread README.md Outdated
@FreddyDgh
Copy link
Copy Markdown
Contributor Author

https://github.com/dotnet/runtime/blob/master/docs/project/dogfooding.md has the detailed instructions for how to consume the nightly builds. I think that the readme should just have a link to this page.

If we link to this page, would it be possible to add a separate section aimed at people who are just interested in fixes for a specific library and aren't trying to get a preview version of the whole entire runtime? I'm not in love with having the feeds buried down in Step 4 of the "Install prerequisites" section, when you are generally looking for them to be in a "Step 1" somewhere.

@jkotas
Copy link
Copy Markdown
Member

jkotas commented Mar 28, 2020

Yes, I agree with having a short section at top aimed at people who just want fixes for a specific library.

* Link homepage to existing dogfooding.md page

* Add section for Obtaining nightly builds of NuGet packages
@FreddyDgh
Copy link
Copy Markdown
Contributor Author

@jkotas See the new commit I just made. Do you think this makes more sense?

Also note that I have a couple instances marked with MSFT TODO where someone from Microsoft should give input. It's okay by me if someone wants to just make changes themselves and integrate them into this PR, or just discard this one and start a new PR entirely.

Comment thread docs/project/dogfooding.md Outdated
Comment thread docs/project/dogfooding.md Outdated

## Obtaining nightly builds of NuGet packages

If you are only looking to get fixes for an individual NuGet package, and don't need a preview version of the entire runtime, you can add the following package feed to `NuGet.config`:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Adding this feed won't automatically give you any fixes. You also need to update the versions of the NuGet packages.

Comment thread docs/project/dogfooding.md Outdated
Comment thread docs/project/dogfooding.md Outdated
Comment thread docs/project/dogfooding.md Outdated
4. Our nightly builds are uploaded to dotnet-blob feeds, not NuGet - so ensure the .NET Core blob feed is in your nuget configuration in case you need other packages from .NET Core that aren't included in the download. For example, on Windows you could edit `%userprofile%\appdata\roaming\nuget\nuget.config` or on Linux edit `~/.nuget/NuGet/NuGet.Config` to add these line:
4. Our nightly builds are uploaded to dotnet-blob feeds, not NuGet - so ensure the .NET Core blob feed is in your nuget configuration in case you need other packages from .NET Core that aren't included in the download. For example, on Windows you could edit `%userprofile%\appdata\roaming\nuget\nuget.config` or on Linux edit `~/.nuget/NuGet/NuGet.Config` to add these lines:

**MSFT TODO:** Someone at Microsoft should update these to make sure they are not outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

All feeds except gRPC repository should be replaced by https://dnceng.pkgs.visualstudio.com/public/_packaging/dotnet5/nuget/v3/index.json

Copy link
Copy Markdown
Member

@jkotas jkotas left a comment

Choose a reason for hiding this comment

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

Thank you!

@jkotas jkotas merged commit 917c1a8 into dotnet:master Mar 28, 2020
@FreddyDgh FreddyDgh deleted the doc-nightly branch March 28, 2020 21:08
@ghost ghost locked as resolved and limited conversation to collaborators Dec 10, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants