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

Documentation improvement #71

Closed
dnknitro opened this issue Jun 6, 2018 · 5 comments
Closed

Documentation improvement #71

dnknitro opened this issue Jun 6, 2018 · 5 comments
Assignees

Comments

@dnknitro
Copy link

dnknitro commented Jun 6, 2018

Current documentation lacks very important part: examples of usage of the classes/settings. I know you have getting started, but it is not sufficient. I think main "build" tools, like using MSBuild, NUnit / MSTest, Code Coverage (Open Cover) should be documented with nice and working examples.

@matkoch
Copy link
Member

matkoch commented Jul 7, 2018

Tracked here with https://github.com/nuke-build/web/pull/2. If you like, you can take a look at it.

@matkoch matkoch self-assigned this Jul 7, 2018
@matkoch
Copy link
Member

matkoch commented Jul 12, 2018

@dnknitro did you have a chance to take a look? Anything missing from your point of view?

@dnknitro
Copy link
Author

Yeah, I looked through the whole page. I remember when I was trying nuke.build for the first time I had issues with actually invoking commands like OpenCover, MS Test etc. because all of those lacked executable tool path. So I had to figure out how to get that path and setup nuke.build target appropriately so it works both locally and on the build server.

I have not tried to follow this new wiki page with instructions though, just read it.

@matkoch
Copy link
Member

matkoch commented Jul 12, 2018

@dnknitro I had a look at your repositories previously already. The way you do it shouldn't be necessary. Nuke should determine the tool path automatically for most tools. Sometimes you need to add them as a package reference though. VsTest and SignTool are one of the few exceptions, where you have to set it yourself.

If you like, you can join our slack or gitter channel to have a chat about that.

@lock
Copy link

lock bot commented Nov 20, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Nov 20, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants