Skip to content

Commit 29a3b3a

Browse files
jpwesselinkaddaleax
jpwesselink
authored and
addaleax
committed
tools, build: refactor macOS installer
Creates macOS pkg installer by using `pkgbuild` and `productbuild`. Removes previous npm installation before installing npm. Packages carry correct version attributes. Support for intl installer features, defaults to `en`. Fancy formatted license. Renamed `osx` references to `macOS`. Optional installation of npm. PR-URL: nodejs/node#15179 Fixes: nodejs/node#15012 Refs: nodejs/node#5656 Refs: nodejs/node#2571 Refs: nodejs/node#7097 Reviewed-By: Lance Ball <lball@redhat.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
1 parent d9ffd1a commit 29a3b3a

12 files changed

Lines changed: 119 additions & 122 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,9 @@ ipch/
7171
/config_fips.gypi
7272
*-nodegyp*
7373
/gyp-mac-tool
74-
/dist-osx
7574
/npm.wxs
7675
/tools/msvs/npm.wixobj
7776
/tools/msvs/genfiles/
78-
/tools/osx-pkg.pmdoc/index.xml
7977
/test/addons/??_*/
8078
email.md
8179
deps/v8-*
@@ -103,6 +101,7 @@ deps/npm/node_modules/.bin/
103101

104102
# build/release artifacts
105103
/*.tar.*
104+
/*.pkg
106105
/SHASUMS*.txt*
107106

108107
# test artifacts

‎Makefile‎

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -676,8 +676,7 @@ BINARYTAR=$(BINARYNAME).tar
676676
XZ=$(shell which xz > /dev/null 2>&1; echo $$?)
677677
XZ_COMPRESSION ?= 9e
678678
PKG=$(TARNAME).pkg
679-
PACKAGEMAKER ?= /Developer/Applications/Utilities/PackageMaker.app/Contents/MacOS/PackageMaker
680-
PKGDIR=out/dist-osx
679+
MACOSOUTDIR=out/macos
681680

682681
release-only:
683682
@if [ "$(DISTTYPE)" != "nightly" ] && [ "$(DISTTYPE)" != "next-nightly" ] && \
@@ -712,24 +711,54 @@ release-only:
712711
fi
713712

714713
$(PKG): release-only
715-
$(RM) -r $(PKGDIR)
716-
$(RM) -r out/deps out/Release
714+
$(RM) -r $(MACOSOUTDIR)
715+
mkdir -p $(MACOSOUTDIR)/installer/productbuild
716+
cat tools/macos-installer/productbuild/distribution.xml.tmpl \
717+
| sed -E "s/\\{nodeversion\\}/$(FULLVERSION)/g" \
718+
| sed -E "s/\\{npmversion\\}/$(NPMVERSION)/g" \
719+
>$(MACOSOUTDIR)/installer/productbuild/distribution.xml ; \
720+
721+
@for dirname in tools/macos-installer/productbuild/Resources/*/; do \
722+
lang=$$(basename $$dirname) ; \
723+
mkdir -p $(MACOSOUTDIR)/installer/productbuild/Resources/$$lang ; \
724+
printf "Found localization directory $$dirname\n" ; \
725+
cat $$dirname/welcome.html.tmpl \
726+
| sed -E "s/\\{nodeversion\\}/$(FULLVERSION)/g" \
727+
| sed -E "s/\\{npmversion\\}/$(NPMVERSION)/g" \
728+
>$(MACOSOUTDIR)/installer/productbuild/Resources/$$lang/welcome.html ; \
729+
cat $$dirname/conclusion.html.tmpl \
730+
| sed -E "s/\\{nodeversion\\}/$(FULLVERSION)/g" \
731+
| sed -E "s/\\{npmversion\\}/$(NPMVERSION)/g" \
732+
>$(MACOSOUTDIR)/installer/productbuild/Resources/$$lang/conclusion.html ; \
733+
done
717734
$(PYTHON) ./configure \
718735
--dest-cpu=x64 \
719736
--tag=$(TAG) \
720737
--release-urlbase=$(RELEASE_URLBASE) \
721738
$(CONFIG_FLAGS) $(BUILD_RELEASE_FLAGS)
722-
$(MAKE) install V=$(V) DESTDIR=$(PKGDIR)
723-
SIGN="$(CODESIGN_CERT)" PKGDIR="$(PKGDIR)/usr/local" bash \
739+
$(MAKE) install V=$(V) DESTDIR=$(MACOSOUTDIR)/dist/node
740+
SIGN="$(CODESIGN_CERT)" PKGDIR="$(MACOSOUTDIR)/dist/node/usr/local" bash \
724741
tools/osx-codesign.sh
725-
cat tools/osx-pkg.pmdoc/index.xml.tmpl \
726-
| sed -E "s/\\{nodeversion\\}/$(FULLVERSION)/g" \
727-
| sed -E "s/\\{npmversion\\}/$(NPMVERSION)/g" \
728-
> tools/osx-pkg.pmdoc/index.xml
729-
$(PACKAGEMAKER) \
730-
--id "org.nodejs.pkg" \
731-
--doc tools/osx-pkg.pmdoc \
732-
--out $(PKG)
742+
mkdir -p $(MACOSOUTDIR)/dist/npm/usr/local/lib/node_modules
743+
mkdir -p $(MACOSOUTDIR)/pkgs
744+
mv $(MACOSOUTDIR)/dist/node/usr/local/lib/node_modules/npm \
745+
$(MACOSOUTDIR)/dist/npm/usr/local/lib/node_modules
746+
unlink $(MACOSOUTDIR)/dist/node/usr/local/bin/npm
747+
unlink $(MACOSOUTDIR)/dist/node/usr/local/bin/npx
748+
$(NODE) tools/license2rtf.js < LICENSE > \
749+
$(MACOSOUTDIR)/installer/productbuild/Resources/license.rtf
750+
cp doc/osx_installer_logo.png $(MACOSOUTDIR)/installer/productbuild/Resources
751+
pkgbuild --version $(FULLVERSION) \
752+
--identifier org.nodejs.node.pkg \
753+
--root $(MACOSOUTDIR)/dist/node $(MACOSOUTDIR)/pkgs/node-$(FULLVERSION).pkg
754+
pkgbuild --version $(NPMVERSION) \
755+
--identifier org.nodejs.npm.pkg \
756+
--root $(MACOSOUTDIR)/dist/npm \
757+
--scripts ./tools/macos-installer/pkgbuild/npm/scripts \
758+
$(MACOSOUTDIR)/pkgs/npm-$(NPMVERSION).pkg
759+
productbuild --distribution $(MACOSOUTDIR)/installer/productbuild/distribution.xml \
760+
--resources $(MACOSOUTDIR)/installer/productbuild/Resources \
761+
--package-path $(MACOSOUTDIR)/pkgs ./$(PKG)
733762
SIGN="$(PRODUCTSIGN_CERT)" PKG="$(PKG)" bash tools/osx-productsign.sh
734763

735764
pkg: $(PKG)

‎tools/macos-installer/pkgbuild/npm/scripts/postinstall‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/bin/sh
2+
3+
cd /usr/local/bin || exit 1
4+
ln -sf ../lib/node_modules/npm/bin/npm-cli.js npm
5+
ln -sf ../lib/node_modules/npm/bin/npx-cli.js npx

‎tools/macos-installer/pkgbuild/npm/scripts/preinstall‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/bin/sh
2+
3+
[[ -d /usr/local/lib/node_modules/npm ]] \
4+
&& rm -rf /usr/local/lib/node_modules/npm
5+
exit 0

‎tools/macos-installer/productbuild/Resources/en.lproj/conclusion.html.tmpl‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<html>
2+
<head>
3+
<style>
4+
body {
5+
font-family: Helvetica;
6+
font-size: 14px;
7+
}
8+
li:last-child {
9+
margin-bottom: 16px;
10+
}
11+
</style>
12+
</head>
13+
<body>
14+
<div>
15+
<p>This package has installed:</p>
16+
<ul>
17+
<li>Node.js {nodeversion} to <code>/usr/local/bin/node</code></li>
18+
<li>npm {npmversion} to <code>/usr/local/bin/npm</code></li>
19+
</ul>
20+
<p>Make sure that <code>/usr/local/bin</code> is in your <code>$PATH</code>.</p>
21+
</div>
22+
</body>
23+
</html>

‎tools/macos-installer/productbuild/Resources/en.lproj/welcome.html.tmpl‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<html>
2+
<head>
3+
<style>
4+
body {
5+
font-family: Helvetica;
6+
font-size: 14px;
7+
}
8+
</style>
9+
</head>
10+
<body>
11+
<div>
12+
<p>This package will install:</p>
13+
<ul>
14+
<li>Node.js {nodeversion} to <code>/usr/local/bin/node</code></li>
15+
<li>npm {npmversion} to <code>/usr/local/bin/npm</code></li>
16+
</ul>
17+
</div>
18+
</body>
19+
</html>

‎tools/macos-installer/productbuild/distribution.xml.tmpl‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<installer-gui-script minSpecVersion="1">
3+
<title>Node.js</title>
4+
<welcome file="welcome.html"/>
5+
<conclusion file="conclusion.html"/>
6+
<background alignment="topleft" file="osx_installer_logo.png"/>
7+
<pkg-ref id="org.nodejs.node.pkg" auth="root"/>
8+
<pkg-ref id="org.nodejs.npm.pkg" auth="root"/>
9+
<options customize="allow" require-scripts="false"/>
10+
<license file="license.rtf"/>
11+
<choices-outline>
12+
<line choice="org.nodejs.node.pkg" />
13+
<line choice="org.nodejs.npm.pkg"/>
14+
</choices-outline>
15+
<choice id="org.nodejs.node.pkg" visible="true" title="Node.js {nodeversion}">
16+
<pkg-ref id="org.nodejs.node.pkg"/>
17+
</choice>
18+
<pkg-ref id="org.nodejs.node.pkg" version="{nodeversion}" onConclusion="none">node-{nodeversion}.pkg</pkg-ref>
19+
<choice id="org.nodejs.npm.pkg" visible="true" title="npm {npmversion}">
20+
<pkg-ref id="org.nodejs.npm.pkg"/>
21+
</choice>
22+
<pkg-ref id="org.nodejs.npm.pkg" version="{npmversion}" onConclusion="none">npm-{npmversion}.pkg</pkg-ref>
23+
</installer-gui-script>

‎tools/osx-pkg.pmdoc/01local-contents.xml‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎tools/osx-pkg.pmdoc/01local.xml‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎tools/osx-pkg.pmdoc/02npm-contents.xml‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)