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.

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

Show version number for "SDK" packages in Solution Explorer #2807

Merged
merged 1 commit into from
Sep 12, 2017

Conversation

tmeschter
Copy link
Contributor

@tmeschter tmeschter commented Sep 8, 2017

Currently we include the version number in the caption for package items under the Dependencies node in Solution Explorer, like this:

StyleCop.Analyzers (1.0.2)

However, we don't do the same thing for items under the SDK node. In this case the model for SDK dependencies supports a version number; we just need to update the caption to show it.

Note that the SDK dependencies are ultimately backed by items produced by the CollectSDKReferencesDesignTime task in the dotnet/sdk repo, and these items currently do not include Version metadata. That will go in as a separate change (see dotnet/sdk#1572), and only once both of these changes come together will you see the version number in Solution Explorer.

Customer scenario

Customer wishes to see which version of NETStandard.Library or Microsoft.NETCore.App their project is using. The natural place to put this is on the node in the Solution Explorer, but we don't currently:

image

We do show the version number for NuGet packages, though.

Bugs this fixes:

Related to #2248.

Workarounds, if any

Examine the project file directly, or open the project properties.

Risk

Low.

Performance impact

Low; this is just a change to how we display the package name.

Is this a regression from a previous update?

No.

Root cause analysis:

Overlooked as part of the initial Dependencies node work, possibly because it requires changes in dotnet/SDK to light up.

How was the bug found?

Internal use.

Related to dotnet#2248.

Currently we include the version number in the caption for _package_ items under the Dependencies node in Solution Explorer, like this:

> StyleCop.Analyzers (1.0.2)

However, we don't do the same thing for items under the SDK node. In this case the model for SDK dependencies supports a version number; we just need to update the caption to show it.

Note that the SDK dependencies are ultimately backed by items produced by the `CollectSDKReferencesDesignTime` task in the [dotnet/sdk](https://github.com/dotnet/sdk) repo, and these items currently do not include `Version` metadata. That will go in as a separate change, and only once both of these changes come together will you see the version number in Solution Explorer.
@tannergooding
Copy link
Member

@tmeschter, how does this work with pre-release SDK?

Also, will this make it easier to display the target frameworks (if multi-targeting) in the properties pages?

@tmeschter
Copy link
Contributor Author

@tannergooding So despite the use of the term "SDK" everywhere, this doesn't have anything to do with the version of the SDK you're using. Rather, it's just about surfacing the version of the Microsoft.NETCore.App or NETStandard.Library packages (or any other package we consider to be an "SDK" reference rather than a "normal" reference).

I don't actually know the rationale behind surfacing these under the SDK node rather than the Packages node, though they are obviously fundamental in a way other packages are not.

I intend to make a separate change to show the version of the SDK on the SDK node itself. But that has no overlap with this.

@tmeschter
Copy link
Contributor Author

@tannergooding As for your question about the properties pages, I don't know. I don't know enough about how those are backed.

@tmeschter tmeschter changed the title Show version number for SDK items in Solution Explorer Show version number for "SDK" packages in Solution Explorer Sep 11, 2017
@tmeschter tmeschter merged commit bf262ce into dotnet:master Sep 12, 2017
@tmeschter tmeschter deleted the ShowSDKVersion branch September 12, 2017 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants