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

Please document the list of NuGet packages in README.md #1392

Closed
jnm2 opened this issue Jan 25, 2018 · 5 comments
Closed

Please document the list of NuGet packages in README.md #1392

jnm2 opened this issue Jan 25, 2018 · 5 comments
Assignees

Comments

@jnm2
Copy link

jnm2 commented Jan 25, 2018

It's hard to discover information about which NuGet packages should be used and when. Please add a readme section which lists the main NuGet packages to use and why each one exists.

For example, when I need to run vstest.console.exe from a build script on a build server without VS installed, which is the smallest NuGet package or metapackage which I need?

I happen to know the answer to that question now, but I initially failed to find anything and I just happened to be told as part of another issue.

@heaths
Copy link
Member

heaths commented Jan 25, 2018

Or, more generally, how this is expected to be used? The vstest-docs repo covers the architecture, extensibility, and more well, but where's a doc that just says whether this effectively replaces calling out to the VS-installed adapter, and other brief "how to" content. That should be covered in this repo's README.md, IMO. Given the current difficulties in calling vstest.console.exe, can developers just expect to install these packages and not have to worry about how to find vstest.console.exe?

@pvlakshm
Copy link
Contributor

Please see here: 0014-Packaging.md.

@heaths
Copy link
Member

heaths commented Feb 20, 2018

On GitHub, it's more common to list these in the README (or a link therefrom) or in the wiki that is included in all projects by default. I wasn't expecting to spelunk for documentation

@jnm2
Copy link
Author

jnm2 commented Feb 22, 2018

That looks great! It's exactly what I hoped for!

Now, can this be done for all packages published from this repo?

For example, when writing a test adapter, you'd want to reference Microsoft.TestPlatform.ObjectModel.

Or here's something I'm looking at right now. In the tests for the NUnit adapter, I want to create an ITestCaseFilterExpression from a given string to test against. The keys to that are public in Microsoft.VisualStudio.TestPlatform.Common.dll. So what I'm hoping to know is, which NuGet package should I reference? Microsoft.TestPlatform.TestHost seems like the smallest package which contains it, but the lib/net45 assemblies are missing. Do you think it's possible for the NuGet package documentation to answer questions like this?

@mayankbansal018
Copy link
Contributor

@pvlakshm , can you please update the readme, & close this

pvlakshm added a commit that referenced this issue Aug 21, 2018
Added links to all RFCs to address #1392.
singhsarab pushed a commit that referenced this issue Sep 11, 2018
Added links to all RFCs to address #1392.

* refined link test to .NET Core CC RFC.

* Update README.md
smadala pushed a commit to smadala/vstest that referenced this issue Oct 5, 2018
Added links to all RFCs to address microsoft#1392.

* refined link test to .NET Core CC RFC.

* Update README.md

(cherry picked from commit 4d89670)
smadala added a commit that referenced this issue Oct 8, 2018
* Verify NS.JSon is loaded appropriately in case of DisableAppDomain (#1740)

* reverting back app domain culture setup

* binding redirect for TW.Interfaces

* Run net451 test for Newtonsoft dependency

(cherry picked from commit 3cbab0b)

* Run tests only for test projects (#1745)


(cherry picked from commit a2b4196)

* Upgrading the version of VSSDK Build tools nuget, because the older one is incompatible with the latest VSSDK. (#1761)


(cherry picked from commit d391224)

* Added linkes to all RFCs (#1743)

Added links to all RFCs to address #1392.

* refined link test to .NET Core CC RFC.

* Update README.md

(cherry picked from commit 4d89670)

* Get latest extensions from VS d15.9stg branch (#1771)


(cherry picked from commit d5c4415)

* Add info log if try to run tests with no IsTestProject prop (#1778)

* Add info log if try to run tests with no IsTestProject prop

* Add message to resources

* invert check

(cherry picked from commit 3decca0)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants