Skip to content

Commit 74388bb

Browse files
committed
feat: specified icon not being used when generating osx build
Close #519
1 parent c56f583 commit 74388bb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+970
-621
lines changed

.idea/dictionaries/develar.xml

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/typescript-compiler.xml

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ cache:
1919
before_install:
2020
- brew install --ignore-dependencies --force-bottle gnu-tar dpkg libicns graphicsmagick lzip freetype
2121
- brew deps --skip-optional wine | grep -v -e freetype -e libtiff -e libpng -e libtool -e libicns -e jpeg -e gmp | xargs brew install --ignore-dependencies --force-bottle
22-
- brew install --ignore-dependencies --force-bottle wine mono
22+
- brew install --ignore-dependencies --force-bottle wine
2323
- mkdir -p /tmp/git-lfs && curl -L https://github.com/github/git-lfs/releases/download/v1.2.0/git-lfs-$([ "$TRAVIS_OS_NAME" == "linux" ] && echo "linux" || echo "darwin")-amd64-1.2.0.tar.gz | tar -xz -C /tmp/git-lfs --strip-components 1 && /tmp/git-lfs/git-lfs pull
2424

2525
install:

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This includes:
1212
- log of the terminal output
1313
- node version
1414
- npm version
15-
- on which system do you want to create installers (OS X, Windows or Linux)
15+
- on which system do you want to create installers (MacOS, Windows or Linux)
1616

1717
# Pull Requests
1818
To check that your contributions match the project coding style make sure `npm test` passes.

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# electron-builder [![npm version](https://img.shields.io/npm/v/electron-builder.svg)](https://npmjs.org/package/electron-builder)
2-
Complete solution to package and build ready for distribution and "auto update" Electron app for OS X, Windows and Linux.
2+
Complete solution to package and build ready for distribution and "auto update" Electron app for MacOS, Windows and Linux.
33

44
* NPM packages management:
55
* [Native application dependencies](http://electron.atom.io/docs/latest/tutorial/using-native-node-modules/) compilation (only if [two-package.json project structure](#two-packagejson-structure) used).
@@ -9,9 +9,9 @@ Complete solution to package and build ready for distribution and "auto update"
99
* [Build version management](https://github.com/electron-userland/electron-builder/wiki/Options#build-version-management).
1010
* Numerous target formats:
1111
* All platforms: `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`.
12-
* [OS X](https://github.com/electron-userland/electron-builder/wiki/Options#OsXBuildOptions-target): `dmg`, `mas`.
12+
* [MacOS](https://github.com/electron-userland/electron-builder/wiki/Options#MacOptions-target): `dmg`, `mas`.
1313
* [Linux](https://github.com/electron-userland/electron-builder/wiki/Options#LinuxBuildOptions-target): `deb`, `rpm`, `freebsd`, `pacman`, `p5p`, `apk`.
14-
* Windows: Squirrel.Windows. NSIS will be supported soon.
14+
* [Windows](https://github.com/electron-userland/electron-builder/wiki/Options#WinBuildOptions-target): NSIS, Squirrel.Windows.
1515
* [Publishing artifacts to GitHub Releases](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts).
1616

1717
[electron-packager](https://github.com/electron-userland/electron-packager) and
@@ -59,9 +59,9 @@ For a production app you need to sign your application, see [Where to buy code s
5959
```
6060
See [options](https://github.com/electron-userland/electron-builder/wiki/Options). This object will be used as a source of [electron-packager](https://www.npmjs.com/package/electron-packager#packageropts-callback) options. You can specify any other options here.
6161

62-
3. Create directory `build` in the root of the project and put your `background.png` (OS X DMG background), `icon.icns` (OS X app icon) and `icon.ico` (Windows app icon).
62+
3. Create directory `build` in the root of the project and put your `background.png` (MacOS DMG background), `icon.icns` (MacOS app icon) and `icon.ico` (Windows app icon).
6363

64-
<a id="user-content-linuxIcon" class="anchor" href="#linuxIcon" aria-hidden="true"></a>Linux icon set will be generated automatically on the fly from the OS X `icns` file (or you can put them into the `build/icons` directory — filename must contains size (e.g. `32x32.png`)).
64+
<a id="user-content-linuxIcon" class="anchor" href="#linuxIcon" aria-hidden="true"></a>Linux icon set will be generated automatically on the fly from the MacOS `icns` file (or you can put them into the `build/icons` directory — filename must contains size (e.g. `32x32.png`)).
6565

6666
4. Add [scripts](https://docs.npmjs.com/cli/run-script) to the development `package.json`:
6767
```json
@@ -80,7 +80,7 @@ Please note — packaged into an asar archive [by default](https://github.com/el
8080
# Auto Update
8181
`electron-builder` produces all required artifacts:
8282

83-
* `.dmg`: OS X installer, required for OS X user to initial install.
83+
* `.dmg`: MacOS installer, required for MacOS user to initial install.
8484
* `-mac.zip`: required for Squirrel.Mac.
8585
* `.exe` and `-ia32.exe`: Windows installer, required for Windows user to initial install. Please note — [your app must handle Squirrel.Windows events](https://github.com/electronjs/windows-installer#handling-squirrel-events). See [real example](https://github.com/develar/onshape-desktop-shell/blob/master/src/WinSquirrelStartupEventHandler.ts).
8686
* `.full-nupkg`: required for Squirrel.Windows.
@@ -95,17 +95,17 @@ For windows consider only [distributing 64-bit versions](https://github.com/elec
9595
# CLI Usage
9696
Execute `node_modules/.bin/build --help` to get actual CLI usage guide.
9797
```
98-
--osx, -o Build for OS X [array]
98+
--mac, -o Build for MacOS [array]
9999
--linux, -l Build for Linux [array]
100100
--win, -w, --windows Build for Windows [array]
101101
--x64 Build for x64 [boolean]
102102
--ia32 Build for ia32 [boolean]
103103
--publish, -p Publish artifacts (to GitHub Releases), see
104104
https://goo.gl/WMlr4n
105105
[choices: "onTag", "onTagOrDraft", "always", "never"]
106-
--platform The target platform (preferred to use --osx, --win or
106+
--platform The target platform (preferred to use --mac, --win or
107107
--linux)
108-
[choices: "osx", "win", "linux", "darwin", "win32", "all"]
108+
[choices: "mac", "win", "linux", "darwin", "win32", "all"]
109109
--arch The target arch (preferred to use --x64 or --ia32)
110110
[choices: "ia32", "x64", "all"]
111111
--help Show help [boolean]
@@ -123,7 +123,7 @@ const Platform = builder.Platform
123123
124124
// Promise is returned
125125
builder.build({
126-
targets: Platform.OSX.createTarget(),
126+
targets: Platform.MAC.createTarget(),
127127
devMetadata: {
128128
"//": "build and other properties, see https://goo.gl/5jVxoO"
129129
}

appveyor.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ cache:
55
- node_modules
66
- '%APPDATA%\npm-cache'
77
- '%USERPROFILE%\.electron'
8+
- '%USERPROFILE%\.cache\nsis'
89

910
install:
1011
- ps: Install-Product node 6 x64

docker/6/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
FROM electronuserland/electron-builder:base
22

3-
ENV NODE_VERSION 6.2.1
3+
ENV NODE_VERSION 6.2.2
44

55
# https://github.com/npm/npm/issues/4531
66
RUN curl -SLO "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-x64.tar.xz" \

docs/Code Signing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
OS X and Windows code signing is supported. Windows is dual code-signed (SHA1 & SHA256 hashing algorithms).
1+
MacOS and Windows code signing is supported. Windows is dual code-signed (SHA1 & SHA256 hashing algorithms).
22

3-
On a OS X development machine valid and appropriate identity from your keychain will be automatically used.
3+
On a MacOS development machine valid and appropriate identity from your keychain will be automatically used.
44

55
| Env name | Description
66
| -------------- | -----------

docs/Multi Platform Build.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,33 @@ Don't expect that you can build app for all platforms on one platform.
33
* If your app has native dependencies, it can be compiled only on the target platform.
44
[prebuild](https://www.npmjs.com/package/prebuild) is a solution, but most node modules [don't provide](https://github.com/atom/node-keytar/issues/27) prebuilt binaries.
55

6-
* OS Code Signing works only on OS X. [Cannot be fixed](http://stackoverflow.com/a/12156576).
6+
* OS Code Signing works only on MacOS. [Cannot be fixed](http://stackoverflow.com/a/12156576).
77

8-
Don't think that mentioned issues are major, you should use build servers — e.g. [AppVeyor](http://www.appveyor.com/) to build Windows app and [Travis](https://travis-ci.org) to build OS X/Linux apps.
8+
Don't think that mentioned issues are major, you should use build servers — e.g. [AppVeyor](http://www.appveyor.com/) to build Windows app and [Travis](https://travis-ci.org) to build MacOS/Linux apps.
99

1010
See [sample appveyor.yml](https://github.com/develar/onshape-desktop-shell/blob/master/appveyor.yml) to build Electron app for Windows.
11-
And [sample .travis.yml](https://github.com/develar/onshape-desktop-shell/blob/master/.travis.yml) to build Electron app for OS X.
11+
And [sample .travis.yml](https://github.com/develar/onshape-desktop-shell/blob/master/.travis.yml) to build Electron app for MacOS.
1212

1313
By default build for current platform and current arch. Use CLI flags `--osx`, `--win`, `--linux` to specify platforms. And `--ia32`, `--x64` to specify arch.
1414

15-
For example, to build app for OS X, Windows and Linux:
15+
For example, to build app for MacOS, Windows and Linux:
1616
```
17-
npm run build -owl
17+
build -mwl
1818
```
1919

2020
Build performed in parallel, so, it is highly recommended to not use npm task per platform (e.g. `npm run dist:osx && npm run dist:win32`), but specify multiple platforms/targets in one build command.
2121
You don't need to clean dist output before build — output directory is cleaned automatically.
2222

23-
## OS X
23+
## MacOS
2424

2525
Use [brew](http://brew.sh) to install required packages.
2626

27-
To build app in distributable format for Windows on OS X:
27+
To build app in distributable format for Windows on MacOS:
2828
```
2929
brew install Caskroom/cask/xquartz wine mono
3030
```
3131

32-
To build app in distributable format for Linux on OS X:
32+
To build app in distributable format for Linux on MacOS:
3333
```
3434
brew install gnu-tar libicns graphicsmagick
3535
```

0 commit comments

Comments
 (0)