#629 Update and consolidate Windows install instructions #867

mousetraps · 2016-01-18T08:28:44Z

Point to new VC++ Build Tools Technical Preview.
Simplify and consolidate install instructions for all Windows versions.

As described in #629 (comment), the new VC++ build tools provide a minimal set of C++ dependencies on Windows, so there is no longer a need to install full-blown VS. The Build Tools are currently in Technical Preview, but so far folks on the thread have pretty good success with them so far. Currently it is necessary to install both the Windows 8.1 & Windows 10 SDKs, but at RTM, the more minimal default install should be sufficient.

I also went ahead and generally simplified / consolidated the instructions because some of them were too complex, some of them were too sparse, and the repetition was just plain unnecessary & confusing. Additionally I added a link to our Node.js Guidelines for Windows, which provides additional helpful tips.

I've tested both the Technical Preview and VS2015 Community instructions on Windows 7, 8, 8.1, and 10 with the following packages.

bson
bufferutil
kerberos
node-sass
node_sqlite3
phantomjs
utf-8-validate

cc: @orangemocha, @jasonwilliams200OK, @thealphanerd, @am11, @mluparu

* Point to new VC++ Build Tools Technical Preview. * Simplify and consolidate install instructions for all Windows versions.

mcollina · 2016-01-18T08:48:28Z

👍 for me.

am11 · 2016-01-18T09:01:37Z

👍 for simplification. LGTM.

rvagg · 2016-01-18T09:04:13Z

/cc @nodejs/platform-windows any additional help reviewing would be appreciated

orangemocha · 2016-01-18T15:44:22Z

README.md

+    * Install [Python 2.7](https://www.python.org/downloads/) (`v3.x.x` is not supported), and run `npm config set python python2.7` (or see below for further instructions on specifying the proper Python version and path.)
+    * Launch cmd, `npm config set msvs_version 2015`
+
+    If the above steps didn't work for you, please visit [Microsoft's Node.js Guidelines for Windows](https://github.com/Microsoft/nodejs-guidelines/blob/master/windows-environment.md#compiling-native-addon-modules) for additional tips.


Maybe keep this paragraph with the bulleted list to make it clear that it still pertains to Windows?

I just finished trying to follow these steps with the following windows / node / npm versions

npm ERR! Windows_NT 10.0.14332 npm ERR! argv "C:\\Program Files\\nodejs\\node.exe" "C:\\Program Files\\nodejs\\node_modules\\npm\\bin\\npm-cli.js" "install" "heapdump" npm ERR! node v4.4.4 npm ERR! npm v2.15.1

I received the error

MSBUILD : error MSB4132: The tools version "2.0" is unrecognized. Available tools versions are "14.0", "4.0".

edit: I had followed option 1. to install visual c++ build tools. In order to get gyp to work correctly I needed to include the flag --msvs_version=2015

I was able to make this a permanent setting with the command npm set msvs_version 2015
This should likely be added to the guide for option 1 (not sure if it is needed for the other options)

orangemocha · 2016-01-18T15:44:56Z

One minor nit, feel free to take it or leave it. LGTM

domenic · 2016-01-18T17:32:07Z

Do these actually work? Last I checked V8 failed to compile with 2015 every once in a while, especially on x64. The issue is that 2015 is not yet supported in the Chromium build pipeline so it gets broken every once in a while as changes are committed that fail in 2015. And the VC++ Build Tools are definitely not tested.

That said, if our current release works using both these configurations, and we have both of them in CI, then this is nice. But we should not recommend configurations that are not actively tested in CI on every commit.

ralphtheninja · 2016-01-18T17:54:44Z

Nice!

MylesBorins · 2016-01-18T20:51:12Z

@mousetraps thank you so much for putting this together. I'm on the slopes of Tahoe today, but I'll follow these instructions to provision a Windows box tomorrow.

rvagg · 2016-01-18T23:52:40Z

@domenic we have vs2015 as part of our CI set now so it's regularly tested for Node.js releases: https://ci.nodejs.org/job/node-compile-windows/, if the build part gets broken in vs2015 then we'd notice it, so far I'm not aware of anything causing problems with stable V8 as it lands in master.

domenic · 2016-01-18T23:55:03Z

@rvagg That sounds like a good start. Do you have VS2015 doing x64 builds in particular? And do you have builds created with the VC++ Build Tools suggested in this PR? Mainly I just don't think we should recommend anything that isn't tested in CI.

rvagg · 2016-01-18T23:56:48Z

@domenic good questions, that I will have to defer to @orangemocha and @joaocgreis on.

/cc @nodejs/build

am11 · 2016-01-19T04:45:57Z

@domenic, FWIW, VCBuildTools is packing the same version of cl.exe, link.exe etc. as VS2015 Update 1. So as such VCBuildTools is a subset of VS2015Update1.

domenic · 2016-01-19T05:14:28Z

@am11 yep, which is what worries me. If it were a superset I'd imagine there are no problems, but as a subset it might not be sufficient to build---it isn't yet for V8, if I recall the bugs. Or maybe that's Chrome...

orangemocha · 2016-01-19T20:23:59Z

@domenic good points. We can and should definitely add the VC++ build tools in CI for node builds. I'll give that a try...

Sogl · 2016-01-20T01:13:28Z

👍

bnoordhuis · 2016-02-04T21:18:06Z

Reviewers, is this PR good to land?

orangemocha · 2016-02-05T00:24:58Z

Not just yet. We ran into some issues building Node itself with the VC++ build tools and we are trying to figure out a way to fix it in the tools or update the instructions to avoid trouble for those users who also build Node. We should have an update shortly.

MylesBorins · 2016-03-24T20:32:28Z

@orangemocha any movement here? I think I'll be getting a windows box soon and can help if this is blocked

orangemocha · 2016-03-24T21:40:21Z

hey @thealphanerd , nice to hear that you'll be working on Windows and thanks for the offer to help!

So the Visual C++ Build Tools (aka VCBT) have been in Node CI for quite some time but in the process of adding them we discovered an issue with the environment scripts that required some hacking to set up the environment. The issue was fixed in Update 2, but there is still an issue that prevents from building Node when the repo is on a different drive than the VCBT. Note that this doesn't affect building modules.

So in summary this change is almost ready to go, but it would need at least an updated link to the most recent update, and I would prefer for it to have a disclaimer to continue using full VS for users who also build Node. BUT, another pre-release update is supposed to come out at the end of March with the fix for the drive issue, so at this point it might be easier to just wait until then.

MylesBorins · 2016-03-24T23:10:24Z

@orangemocha thanks for the update!

@mousetraps thanks for the patience. This is really going to help a lot of people when it becomes the standard documentation!!!

dalinwilliams · 2016-03-25T22:04:29Z

@mousetraps

Thanks for this update! I'm working on getting this to work on Nano Server, the interface-less version of windows server. Other than the VC Build Tools, can you think of anything else to run in order to get node-gyp to work on Nano?

Thanks everyone!

bsclifton · 2016-04-17T21:24:03Z

Changes look good 👍 The only thing I'd suggest would be a troubleshooting section. I think many people (like me) don't have a clean install and MSBuild ends up not resolving things properly. More details about that in #679 (comment)

bsclifton · 2016-04-23T08:00:38Z

@orangemocha @mousetraps - looks like the official release for the Visual C++ Build Tools 2015 happened 😃 I think the PR needs to be updated (under option 1) to link to it, then this should be ready, right?
https://blogs.msdn.microsoft.com/vcblog/2016/03/31/announcing-the-official-release-of-the-visual-c-build-tools-2015/

mousetraps · 2016-05-13T16:54:10Z

Hey everyone, just updated the readme to point to the new version of the Visual C++ build tools, and also removed the requirement to use a custom install because we've addressed that in the product. Lmk if there's anything else!

MylesBorins · 2016-05-13T16:55:45Z

amazing @mousetraps!

I'll go through with a fresh VM and see if I can get things working following this guide

orangemocha · 2016-05-13T17:07:00Z

Awesome! The VC++ build tools have been used in Node's CI for quite some time now, and @joaocgreis and I have also tested this latest version.

LGTM

MylesBorins · 2016-05-13T20:10:56Z

To get things working with option 1 I had to run the command npm set msvs_version 2015

Should this be added to the instructions? Is it needed for the other options?

mousetraps · 2016-05-13T21:09:30Z

@thealphanerd already there! (might be easier to view the .md rendering than the diff itself https://github.com/mousetraps/node-gyp/tree/629#installation)

MylesBorins · 2016-05-13T21:12:40Z

womp... I lose at reading comprehension once again... I will blame it on reading markdown instead of the rendered output.

LGTM!

orangemocha · 2016-05-17T10:39:09Z

Landed in 0880827, with a slightly reworded commit message.

* Point to the latest release of the VC++ Build Tools. * Simplify and consolidate install instructions for all Windows versions. PR-URL: #867 Fixes: #629 Reviewed-By: orangemocha - Alexis Campailla <orangemocha@nodejs.org> Reviewed-By: thealphanerd - Myles Borins <myles.borins@gmail.com>

mscdex · 2016-05-31T04:25:59Z

I'm curious, does this mean that vs2013 will no longer work or be sufficient or ?

nodejs#629 Update and consolidate Windows install instructions

664f340

* Point to new VC++ Build Tools Technical Preview. * Simplify and consolidate install instructions for all Windows versions.

mousetraps mentioned this pull request Jan 18, 2016

Windows post-install screen additional build tools messaging nodejs/node#4111

Closed

orangemocha reviewed Jan 18, 2016
View reviewed changes

bnoordhuis mentioned this pull request Jan 19, 2016

Test about the Visual C++ Build Tools #868

Closed

mousetraps mentioned this pull request Jan 24, 2016

Update native addons environment setup and configuration microsoft/nodejs-guidelines#49

Merged

mscdex mentioned this pull request Feb 2, 2016

I have try to install CAP but npm gave error saying " this is mostly problem with cap package not with npm itself ". mscdex/cap#38

Closed

bnoordhuis mentioned this pull request Feb 16, 2016

Python executable "python" is v3.4.3, which is not supported by gyp #746

Closed

mousetraps mentioned this pull request Feb 25, 2016

Windows 10: The build tools for v120 (Platform Toolset = 'v120') cannot be found. #679

Closed

ghost mentioned this pull request Mar 31, 2016

Windows users are not happy. #629

Closed

bsclifton mentioned this pull request Apr 17, 2016

Update install documentation for Windows users #644

Closed

update readme to point to Visual C++ Build Tools RTM

16375c6

orangemocha closed this May 17, 2016

rvagg mentioned this pull request Jun 14, 2016

Propose v3.3.2 #956

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#629 Update and consolidate Windows install instructions #867

#629 Update and consolidate Windows install instructions #867

mousetraps commented Jan 18, 2016

mcollina commented Jan 18, 2016

am11 commented Jan 18, 2016

rvagg commented Jan 18, 2016

orangemocha Jan 18, 2016

MylesBorins May 13, 2016 •

edited

Loading

orangemocha commented Jan 18, 2016

domenic commented Jan 18, 2016

ralphtheninja commented Jan 18, 2016

MylesBorins commented Jan 18, 2016

rvagg commented Jan 18, 2016

domenic commented Jan 18, 2016

rvagg commented Jan 18, 2016

am11 commented Jan 19, 2016

domenic commented Jan 19, 2016

orangemocha commented Jan 19, 2016

Sogl commented Jan 20, 2016

bnoordhuis commented Feb 4, 2016

orangemocha commented Feb 5, 2016

MylesBorins commented Mar 24, 2016

orangemocha commented Mar 24, 2016

MylesBorins commented Mar 24, 2016

dalinwilliams commented Mar 25, 2016

bsclifton commented Apr 17, 2016

bsclifton commented Apr 23, 2016

mousetraps commented May 13, 2016

MylesBorins commented May 13, 2016

orangemocha commented May 13, 2016

MylesBorins commented May 13, 2016

mousetraps commented May 13, 2016 •

edited

Loading

MylesBorins commented May 13, 2016

orangemocha commented May 17, 2016 •

edited

Loading

mscdex commented May 31, 2016

#629 Update and consolidate Windows install instructions #867

#629 Update and consolidate Windows install instructions #867

Conversation

mousetraps commented Jan 18, 2016

mcollina commented Jan 18, 2016

am11 commented Jan 18, 2016

rvagg commented Jan 18, 2016

orangemocha Jan 18, 2016

Choose a reason for hiding this comment

MylesBorins May 13, 2016 • edited Loading

Choose a reason for hiding this comment

orangemocha commented Jan 18, 2016

domenic commented Jan 18, 2016

ralphtheninja commented Jan 18, 2016

MylesBorins commented Jan 18, 2016

rvagg commented Jan 18, 2016

domenic commented Jan 18, 2016

rvagg commented Jan 18, 2016

am11 commented Jan 19, 2016

domenic commented Jan 19, 2016

orangemocha commented Jan 19, 2016

Sogl commented Jan 20, 2016

bnoordhuis commented Feb 4, 2016

orangemocha commented Feb 5, 2016

MylesBorins commented Mar 24, 2016

orangemocha commented Mar 24, 2016

MylesBorins commented Mar 24, 2016

dalinwilliams commented Mar 25, 2016

bsclifton commented Apr 17, 2016

bsclifton commented Apr 23, 2016

mousetraps commented May 13, 2016

MylesBorins commented May 13, 2016

orangemocha commented May 13, 2016

MylesBorins commented May 13, 2016

mousetraps commented May 13, 2016 • edited Loading

MylesBorins commented May 13, 2016

orangemocha commented May 17, 2016 • edited Loading

mscdex commented May 31, 2016

MylesBorins May 13, 2016 •

edited

Loading

mousetraps commented May 13, 2016 •

edited

Loading

orangemocha commented May 17, 2016 •

edited

Loading