Ipfs-desktop: Add a package builder that generates installers for Win, Mac and Linux

[flyingzumwalt]

Everyday users want to use a native OS installer to install apps. In order to support this, we need to use a package builder like electron-builder to generate those installers.

What to do:

• [ ] Add an electron package builder like electron-builder that gan generate installers for Windows, Mac and Linux
• [ ] Configure the builder so we can automatically generate new installers and release them to dist.ipfs.io

There's some helpful, but slightly outdated, info in #20.

Related Issues: closes #16, closes #20

[daviddias]

This is now possible thanks to the work @thisconnect did on js-ipfsd-ctl. @hacdias does this sound like something you can tackle as well? You can find docs on packaging left by @thisconnect here: https://github.com/ipfs/js-ipfsd-ctl#packaging

[hacdias]

So, this is related to #512. Dear CI master @VictorBjelkholm, the command to build the distributables is:

./node_modules/.bin/electron-forge package --arch=ia32,x64 --platform=win32,linux,darwin

You just need to change the arch and platform flags to build for the desired platforms and arches. The output will be saved on:

./out/{package_type}/{arch}/files_are_here

If it simplifies your life, there is the publish command you can use: https://electronforge.io/cli/publish.

Hope it helps!

[victorb]

@hacdias started working on this here: https://github.com/ipfs-shipyard/station/pull/514 still a work in progress.

[hacdias]

Let's just leave this opened until Packaging is fully working.

[hacdias]

Sooooo! Since @diasdavid merged #514, Jenkins is actually building the right stuff! And the binary for Windows is running flawlessly and I'm very happy with it!!! Thanks @VictorBjelkholm!!!

Although, there is this "problem" on Windows:

We have to sign it somehow as it is stated here so the publisher is recognized and this message doesn't prompt out.

On Ubuntu/Mint this problem persists.

[victorb]

@hacdias woah! That's great news! Hm, signing will be a bit trickier to solve right now, as we don't have secrets-management in jenkins yet but it's planned already because we have other builds that will need it as well.

I think this same problem happens in macOS (you'll need to right-click and then click open instead of double-click, otherwise you get a similar dialog) so maybe not a blocker for now.

[hacdias]

@VictorBjelkholm okay then. Soooo, the only problem are the Linux builds! Those don't add an icon nor anything to the path. I'll try to figure out why.

[daviddias]

@VictorBjelkholm @hacdias can we start adding the working builds (Windows and Mac OS X) to https://dist.ipfs.io/ ?

[victorb]

Manually verified ones, I don't see a problem with that.

However, automatic releases (from jenkins point of view) is missing trusted workers and dealing with secrets from within build jobs. Also, from Stations point of view, we would need to have some sort of testing before automatically release things.

[hacdias]

Only Windows and macOS builds are working correctly right now, right?

[daviddias]

As per @VictorBjelkholm :

09:13 <@daviddias> victorbjelkholm: let's ship those ipfs-station builds!
09:14 <@victorbjelkholm> daviddias: ship as in? Already being built for the three platforms
09:15 <@daviddias> is that so?? https://github.com/ipfs-shipyard/station/issues/508 doesn't tell me that
09:15 <@daviddias> awesome though!

We are ready to make a release! @hacdias would you like to do the honors and fill https://github.com/ipfs-shipyard/station/releases/tag/untagged-50a0768f417fccfc1ed1?

Rough task list:

• [ ] Fill in the release info
• [x] Bump package.json version to 0.3.0 (https://github.com/ipfs-shipyard/station/commit/6e3b3aceb7d6b4c080f3a5f8aa8a2e75a0815270)
• [ ] Upload binaries to the release
• [ ] Write a blog post announcing it

[daviddias]

Do we need Apple and Windows developer accounts to get the releases signed?

[hacdias]

@diasdavid about Windows, check this link: https://docs.microsoft.com/en-us/windows-hardware/drivers/dashboard/get-a-code-signing-certificate

[daviddias]

@lgierth would love your thoughts here (Release Signing)

I'm wondering if we can have a Alpha Release Key that specifically says that all the software is very Alpha and so it should not be trusted independently of the signature checking out.

[hacdias]

@VictorBjelkholm you can set the script to remove the .nupkg files since they aren't needed.

Linux builds are only working with sudo. Permissions are wrong. Can it be a build related thing?

I really want to check this today and let this finished today. I'm not sure if I will be able to do so, but I'll try. Will update this this afternoon.

[hacdias]

@diasdavid can you check if the latest macOS build works?

[daviddias]

Had to give perms for it to run on the Security pane of System Preferences, but yeah, it works!

[hacdias]

Nice! The only problem then is on debian.

[hacdias]

So, I solved the problem on debian but i need your help @VictorBjelkholm:

See this:

https://ci.ipfs.team/blue/organizations/jenkins/IPFS%20Shipyard%2Fstation/detail/master/5/pipeline/15#step-51-log-23

Can you set postinst.sh permissions to be 755 before starting the build? 😄

[victorb]

Huh, that error is new. Before the builds were successful but the resulting
.deb was broken, now the build is broken.

I'll try to change the permissions and see what we get.

On Thu, Dec 14, 2017 at 4:35 PM, Henrique Dias [e-mail]
wrote:

So, I solved the problem on debian but i need your help @VictorBjelkholm
https://github.com/victorbjelkholm:

See this:

https://ci.ipfs.team/blue/organizations/jenkins/IPFS%
20Shipyard%2Fstation/detail/master/5/pipeline/15#step-51-log-23

Can you set postinst.sh permissions to be 755 before starting the build?
😄

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/ipfs-shipyard/station/issues/508#issuecomment-351745455,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAcD9I1jkLByX5Wi6sJk3sZ8nVp8M3M5ks5tAUAngaJpZM4NT8yM
.

[hacdias]

Don't worry, you just need to change the perms of that file. That file is the fix for the debian package 📦

[ghost]

@lgierth would love your thoughts here (Release Signing)

Puh good question -- prior discussions: ipfs/distributions#51

We have a demand for signing web extensions too.

[hacdias]

@VictorBjelkholm hello! How's the state of this?

[hacdias]

@VictorBjelkholm ping.

[victorb]

solved in c2e703c17b6b99fb18db06c7202ea82a7058a23e

[hacdias]

@diasdavid @VictorBjelkholm I think the version from master is ready to be shipped and I'm not aware of any bugs it might have. What do you think?

[victorb]

@hacdias if everything has been tested with those specific binaries, then I say go for it! 👍 My only reservation is towards automatic builds + publish without having any automatic tests.

[hacdias]

@VictorBjelkholm we can skip automatic builds for now until we have tests 😄

@diasdavid let's do this?

[daviddias]

What's the real blocker with automatic builds?

[hacdias]

So, we don't have testes yet, but I do think the current version (on master) is stable enough to be released into dist.ipfs.io. I tested it on Linux (Mint) and Windows and both versions worked fine. @diasdavid tried on macOS.

Despite not having the automatic builds, we can build the packages for each platform and release the first version (@VictorBjelkholm, what happened to Jenkins? It's not building the new versions).

[nothingismagick]

Don’t know if this is stale (yet), but just saw this great recipe on the quasar discord server:

Gitlab CI awesomeness with docker magick

deploy-windows-64:
  stage: deploy
  image: electronuserland/builder:wine
  environment: production-windows-64
  script:
    - npm install --silent --global quasar-cli
    - npm install --silent
    - npm prune
    - npm run pack:win64
  artifacts:
    paths:
      - dist/*.exe
      - dist/*.zip
  only:
    - master

deploy-windows-32:
  stage: deploy
  image: electronuserland/builder:wine
  environment: production-windows-32
  script:
    - npm install --silent --global quasar-cli
    - npm install --silent
    - npm prune
    - npm run pack:win32
  artifacts:
    paths:
      - dist/*.exe
      - dist/*.zip
  only:
    - master

deploy-linux-64:
  stage: deploy
  image: electronuserland/builder
  environment: production-linux-64
  script:
    - npm install --silent --global quasar-cli
    - npm install --silent
    - npm prune
    - npm run pack:linux64
  artifacts:
    paths:
      - dist/*.AppImage
  only:
    - master

deploy-linux-32:
  stage: deploy
  image: electronuserland/builder
  environment: production-linux-32
  script:
    - npm install --silent --global quasar-cli
    - npm install --silent
    - npm prune
    - npm run pack:linux32
  artifacts:
    paths:
      - dist/*.AppImage
  only:
    - master

deploy-spa:
  stage: deploy
  image: node:alpine
  environment: production-spa
  script:
    - npm install --silent --global quasar-cli
    - npm install --silent
    - npm prune
    - quasar build
  artifacts:
    paths:
      - dist/spa-mat/*
  only:
    - master

deploy-pwa:
  stage: deploy
  image: node:alpine
  environment: production-pwa
  script:
    - npm install --silent --global quasar-cli
    - npm install --silent
    - npm prune
    - quasar build --mode pwa
  artifacts:
    paths:
      - dist/pwa-mat/*
  only:
    - master

this is an excerpt of a package.json where we can use electron-builder to package a Quasar Electron app in a distributable format:

"scripts": {
    // (...)
    "prepack:linux64": "quasar build --mode electron --target linux --arch x64",
    "prepack:linux32": "quasar build --mode electron --target linux --arch ia32",
    "prepack:win64": "quasar build --mode electron --target win32 --arch x64",
    "prepack:win32": "quasar build --mode electron --target win32 --arch ia32",
    "pack:linux64": "electron-builder --linux --x64 --prepackaged ./dist/electron-mat/my-app-linux-x64/",
    "pack:linux32": "electron-builder --linux --ia32 --prepackaged ./dist/electron-mat/my-app-linux-ia32/",
    "pack:win64": "electron-builder --win --x64 --prepackaged ./dist/electron-mat/my-app-win32-x64/",
    "pack:win32": "electron-builder --win --ia32 --prepackaged ./dist/electron-mat/my-app-win32-ia32/"
  }

[hacdias]

We do this already! 😄