electron-archive / grunt-download-electron

Grunt task to download Electron

grunt-download-electron

Grunt tasks for downloading Electron and the compatible version of chromedriver.

Installation

Install npm package, next to your project's Gruntfile.js file:

npm install --save-dev grunt-download-electron

Add this line to your project's Gruntfile.js:

grunt.loadNpmTasks('grunt-download-electron');

Options

• version - Required The version of Electron you want to download.
• outputDir - Required Where to put the downloaded Electron release.
• downloadDir - Where to find and save cached downloaded Electron releases.
• symbols - Download debugging symbols instead of binaries, default to false.
• rebuild - Whether to rebuild native modules after Electron is downloaded.
• apm - The path to apm.
• token - The OAuth token to use for GitHub API requests.
• appDir - Where to find the app when rebuilding the native modules. Defaults to the current directory.

Usage

Add the necessary configuration to your Gruntfile.js:

module.exports = function(grunt) {
  grunt.initConfig({
    'download-electron': {
      version: '0.24.0',
      outputDir: 'electron'
    }
  });
};

or your Gruntfile.coffee:

module.exports = (grunt) ->
  grunt.initConfig
    'download-electron':
      version: '0.24.0'
      outputDir: 'electron'

Then you can download Electron to the path you specified:

$ grunt download-electron

If you're doing selenium-testing of your Electron app, you'll need chromedriver, which is distributed with Electron. To download it into the electron directory:

$ grunt download-electron-chromedriver

grunt-download-electron's Issues

download fails because repository changed atom/atom-shell to atom/electon

download fails because repository changed atom/atom-shell to atom/electon, maybe.

$ grunt download-atom-shell                                                             
Running "download-atom-shell" task
>> Cannot find atom-shell v0.23.0 from GitHub [Error: Not Found]
Warning: Task "download-atom-shell" failed. Use --force to continue.

cannot find atom-shell in download-atom-shell task

npm start

[email protected] start /Users/username/Documents/workspace/testapp3
grunt build && ./bin/Atom.app/Contents/MacOS/Atom ./app

Running "download-atom-shell" task

Cannot find atom-shell v0.12.7 from GitHub null
Warning: Task "download-atom-shell" failed. Use --force to continue.

Aborted due to warnings.

npm ERR! Darwin 14.1.0
npm ERR! argv "node" "/usr/local/bin/npm" "start"
npm ERR! node v0.12.0
npm ERR! npm v2.7.1
npm ERR! code ELIFECYCLE
npm ERR! [email protected] start: grunt build && ./bin/Atom.app/Contents/MacOS/Atom ./app
npm ERR! Exit status 3
npm ERR!
npm ERR! Failed at the [email protected] start script 'grunt build && ./bin/Atom.app/Contents/MacOS/Atom ./app'.
npm ERR! This is most likely a problem with the test-atom-app package,
npm ERR! not with npm itself.
npm ERR! Tell the author that this fails on your system:
npm ERR! grunt build && ./bin/Atom.app/Contents/MacOS/Atom ./app
npm ERR! You can get their info via:
npm ERR! npm owner ls test-atom-app
npm ERR! There is likely additional logging output above.

npm ERR! Please include the following file with any support request:
npm ERR! /Users/username/Documents/workspace/testapp3/npm-debug.log

Atom Shell downloaded as non-executable

On Ubuntu 12.04, atom shell is downloaded but fails with Fatal error: spawn ENOENT. The atom binary is there but I can't run it until I do sudo chmod u+x ./atom-shell/atom. Then it seems to run as expected (I've not noticed any obvious problems).

Cross-platform downloads

It would be nice if this grunt task could be configured to download pre-built binaries for all supported platforms. This would allow to package applications, which don't have any binary modules, on any computer.

For node-webkit there is this excellent grunt plugin, which does this exactly this and also packages the executables with your HTML/JavaScript/CSS/... files: grunt-node-webkit-builder.

Cannot unzip under windows with node v0.11.x

The node-unzip used for unzipping under Windows would get into infinite loop when used under node v0.11.x, we should replace it with a more reliable module.

Not downloading atom-shell

I've included the plugin inside my Gruntfile.js as specified in the readme, but when I run
grunt --verbose I only get:

Running "download-atom-shell" task
Verifying properties download-atom-shell.version, download-atom-shell.outputDir exist in config...OK

And that's it - it does not download anything, just stops after that one line.
I've tested this on Linux and OSX and got the same result.

Download broken for latest (v0.13.0) atom-shell release

Looks like atom-shell has changed their release naming convention. Instead of using

atom-shell-{version}-darwin.zip

they've begun using

atom-shell-{version}-darwin-x64.zip

Format for filename changed?

grunt-download-atom-shell has worked like a charm (thanks!) up until I tried to switch to 0.13.1. I appears it is looking for:

atom-shell-v0.13.1-darwin.zip

and the file is

atom-shell-v0.13.1-darwin-x64.zip

Logs:

Running "download-atom-shell" task
Verifying properties download-atom-shell.version, download-atom-shell.outputDir exist in config...OK
>> Cannot find atom-shell-v0.13.1-darwin.zip in atom-shell v0.13.1 release

And my config:

    'download-atom-shell':
      version: '0.13.1'
      outputDir: 'binaries'

spawn ENOENT on OSX

Hi,

I run into this error when executing grunt download-atom-shell on Mavericks:

Running "download-atom-shell" task
Fatal error: spawn ENOENT

The Atom.app package works as expected though my grunt tasks abort because of the error reports. Could be similar to #8?

I use node v0.10.31 and download-atom-shell v0.8.2.

Any help is appreciated.
Thanks!

Explain why rebuild is needed

I'm trying to package atom shell in nixos linux distro, for nix package manager and i don't understand why this step is needed(which breaks deterministic build in our case, because all our packages are build deterministically)?

https://github.com/atom/grunt-download-atom-shell/blob/master/tasks/download-atom-shell-task.coffee#L112

Unable to download atom-shell releases.

Master branch is only able to download 'electron' releases, this makes it unable to download atom-shell v0.23 and older.
#24 is an attempt to fix it, but perhaps there's a better way.

Fatal error: CERT_UNTRUSTED

On ANTERGOS, however applies to Arch Linux in general currently.

Uname: 'Linux ANTERGOS 3.17.6-1-ARCH #1 SMP PREEMPT Sun Dec 7 23:43:32 UTC 2014 x86_64 GNU/Linux'

grunt -v in build/

Running "download-atom-shell" task
Verifying properties download-atom-shell.version, download-atom-shell.outputDir exist in config...OK
Fatal error: CERT_UNTRUSTED

Atom / Debian issues

Hello,

I'm packaging atom [1] for debian [2].
Your software is there included.

I found some issues in your software:

• In your source files are no copyright / license tags [3]
  and / or
• you have no LICENSE file at your top directory

Regards,
Jörg Frings-Fürst

[1] http://atom.io
[2] https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=747824
[3]
// Copyright 20xx-20xx your name
// License: [your license eg. MIT / GPL-2 ....]

Rebuilding native modules breaks the asar module.

It appears that grunt-download-atom-shell is not compatible with any project that uses asar [ asar, grunt-asar, etc].

After native modules have been built by the download-atom-shell task, any calls to the asar module will fail with "Warning: Module version mismatch. Expected 14, got 43. Use --force to continue."

This is a persistent error - asar must be reinstalled in order to work again.

Example files that can be used to demonstrate this:
Gruntfile.js: http://pastebin.com/RxgXFXhY
package.json: http://pastebin.com/UCyXEvD1

Use those, run npm install to get the modules installed, and then grunt -v - you should see the above error.

This appears related to apm rebuilding the version of chromium-pickle that asar uses, but I'm at a loss for workarounds.

v0.8.0 fails to install atom-shell < v0.13.0 due to missing 'arch' in release filename

Background: I'm starting a new project and included the latest version of this plugin. It works fine for installing atom-shell v0.13.0+, but releases prior to that did not include '-arch' suffix in the release filename, and this change causes it to fail.

Repro: running v0.8.0 of this plugin and installing atom-shell v0.12.7 results in this error:
Cannot find atom-shell-v0.12.3-darwin-x64.zip in atom-shell v0.12.3 release

When you look at the github releases, you'll see the actual filename is atom-shell-v0.12.3-darwin.zip.

I switched back to ~0.7.0 to get this working, but I can submit a PR to make this backwards compatible if you'd like.

-Ben

Task creates Atom.app, should it be Electron.app?

I'm trying to migrate the build scripts for LightTable which is broken since the name change to Electron. In trying to be consistent and remove the mention of Atom everywhere, I notice that this task creates an Atom.app package. I was expecting an Electron.app directory...

I tried recreating this in a new project buy following the same steps LightTable does, and I get ./electron/Atom.app

Gruntfile.js

module.exports = function(grunt) {

  // Project configuration.
  grunt.initConfig({
    pkg: grunt.file.readJSON('package.json'),
    "download-electron": {
      version: "0.22.1",
      outputDir: "./electron",
      rebuild: true
    }
  });

  grunt.loadNpmTasks('grunt-download-electron');

};

package.json

{
    "name": "martin",
        "version": "0.1.0",
        "devDependencies": {
            "grunt": "^0.4.5",
            "grunt-download-electron": "^2.0.0"
        }
}

Then I run

> npm install grunt-cli
> npm install
> ./node_modules/.bin/grunt download-electron

I'm running on
OSX 10.9,5

"Cannot find electron v0.22.1 from GitHub null" 'warning'

We're bumping the version of Electron anyways but this might be pertinent to others.

The error message:

Running "download-electron" task
>> Cannot find electron v0.22.1 from GitHub null
Warning: Task "download-electron" failed. Use --force to continue.

Aborted due to warnings.

We had some users report problems building our app. I couldn't initially reproduce, almost certainly because I already had the relevant version of Electron on my box.

I think I can reproduce the likely source of failure with curl. From my last comment on the issue from my project to which I linked above:

Interestingly, if I run curl https://api.github.com/repos/atom/electron/releases the last release listed in the result is v0.22.2. I suspect that the recent Electron releases – two in the last week alone – bumped the release we were using to the 'second page' of results. I ran curl https://api.github.com/repos/atom/electron/releases/tags/v0.22.1:

{
  "url": "https://api.github.com/repos/atom/electron/releases/1064349",
  "assets_url": "https://api.github.com/repos/atom/electron/releases/1064349/assets",
  "upload_url": "https://uploads.github.com/repos/atom/electron/releases/1064349/assets{?name}",
  "html_url": "https://github.com/atom/electron/releases/tag/v0.22.1",
  "id": 1064349,
  "tag_name": "v0.22.1",
  "target_commitish": "master",
  "name": "atom-shell v0.22.1",
  "draft": false,
  ...

Unable to dowload a 64 bit version for a Windows 64 bit machine

On L28, it is always assumed that a Windows machine is a 32 bit machine. Looking the electron shell releases, it seems that Windows releases are of the type win32-ia32 and win32-x64. So in getArch function, the latter case is never handled.

use node-pre-gyp + npm

it would be super kewl if you could simply npm install atom-shell!

we do this for leveldb and have a package called leveldown-prebuilt that uses node-pre-gyp

most of the setup is in the package.json for that module (e.g. see the binary and scripts keys)

we host the binaries themselves using Releases https://github.com/mafintosh/leveldown-prebuilt/blob/master/package.json

currently the binaries in leveldown-prebuilt are hand compiled, but @springmeyer has some repos set up that use travis/appveyor to auto build new linux/windows binaries and upload them directly on successful builds

what the user sees if their platform doesnt have a prebuilt binary during npm install:

...
npm http 304 https://registry.npmjs.org/object-keys

> [email protected] install /Users/maxogden/src/js/dat/node_modules/leveldown-prebuilt
> node-pre-gyp install --fallback-to-build

node-pre-gyp http GET https://github.com/mafintosh/node-leveldown/releases/download/v0.10.2/leveldown-v0.10.3-node-v11-darwin-x64.tar.gz
node-pre-gyp http 404 https://github.com/mafintosh/node-leveldown/releases/download/v0.10.2/leveldown-v0.10.3-node-v11-darwin-x64.tar.gz
node-pre-gyp http Pre-built binary not available for your system (falling back to source compile with node-gyp) 
  CXX(target) Release/obj.target/leveldb/deps/leveldb/leveldb-1.14.0/db/builder.o
  CXX(target) Release/obj.target/leveldb/deps/leveldb/leveldb-1.14.0/db/db_impl.o
  CXX(target) Release/obj.target/leveldb/deps/leveldb/leveldb-1.14.0/db/db_iter.o
  CXX(target) Release/obj.target/leveldb/deps/leveldb/leveldb-1.14.0/db/filename.o
  CXX(target) Release/obj.target/leveldb/deps/leveldb/leveldb-1.14.0/db/dbformat.o
...

otherwise they get:

...
npm http 304 https://registry.npmjs.org/object-keys

> [email protected] install /Users/maxogden/src/js/dat/node_modules/leveldown-prebuilt
> node-pre-gyp install --fallback-to-build

node-pre-gyp http GET https://github.com/mafintosh/node-leveldown/releases/download/v0.10.2/leveldown-v0.10.3-node-v11-darwin-x64.tar.gz
node-pre-gyp http 200 https://github.com/mafintosh/node-leveldown/releases/download/v0.10.2/leveldown-v0.10.3-node-v11-darwin-x64.tar.gz
[leveldown-prebuilt] Success: "/Users/maxogden/src/js/dat/node_modules/leveldown-prebuilt/build-pre-gyp/leveldown.node" is installed via remote
[email protected] node_modules/leveldown-prebuilt
├── [email protected]
├── [email protected]
├── [email protected]
└── [email protected] ([email protected])