forked from logisim-evolution/logisim-evolution
-
Notifications
You must be signed in to change notification settings - Fork 18
/
Copy pathbuild-mac-release-package.sh
executable file
·216 lines (194 loc) · 11 KB
/
build-mac-release-package.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
#!/bin/bash
# This script is for building the final MacOS executable image. This is a
# comically complicated procedure, for many reasons:
# - Everything below Java 11 is becoming quickly obsolete and difficult to
# support. Libraries and tools are disappearing, packages won't install, etc.
# Solution: Use Java 11, at least for now.
# - Homebrew installs a broken version of AdoptOpenJDK-11 (as of Aug 13, 2018).
# The jmod files included in the install contain the wrong sha256 hashes, so
# jlink fails when attempting to build the modularized java-runtime.
# Workaround: Install AdoptOpenJDK-11 by downloading the mac tar.gz directly
# from github, copy into /Library/Java/JavaVirtualMachines/jdk-11.0.4+11,
# fix the ownership and permissions, and hope for the best.
# - JDK-11 does not include javapackager, jpackager, jpackage, or any similar
# tools. There appears to be no official way to package java applications as
# of JDK 11, and there will not be until Java 13 at the earliest. Yes, this
# seems incomprehensible that there could be no way to package a java
# application for distribution any more.
# There is an unofficial backported jpackager tool discussed here:
# https://mail.openjdk.java.net/pipermail/openjfx-dev/2018-September/022500.html
# It is also possible to install early access JDK 14 (or early access JDK 13),
# which come with a new jpackage tool, which apparently can be used to package
# files created with JDK 11. Both of these appear to be broken in various
# ways: the backport can't deal with license files correctly, and neither sets
# the permissions correctly on the installed files.
# Workaround: Install early access JDK 14, and use that jpackage tool with
# the JDK 11 runtime and build artifacts, combined with a postinstall script
# to fix the permissions.
# - MacOS is becoming increasingly (and rapidly) more strict about running code
# from unsigned/unofficial sources. It seems that the most recent versions of
# MacOS may not be able to run unsigned sources at all, at least not without
# extensive warnings and fiddling with security settings in likely unsafe
# ways. It appears to no longer be tenable to ship unsigned code for MacOS.
# Solution: Get developer keys and sign MacOS installers / executables.
# - Apple's University Developer Program claims to allow for obtaining
# appropriate keys. However, the documentation for creating these keys is
# vague, outdated, and contradictory, at best, and an extended back-and-forth
# with our university account holder and with Apple yields no results. It
# seems that the necessary signing keys are simply no longer possible to
# generate within the University Developer Program.
# Workaround: Use a paid, Individual Apple Developer account to obtain signing
# keys.
# - My current AppleID is enrolled in our University Developer Program. Apple
# confirms that each AppleID can be enrolled in at most one developer program.
# Workaround: Create and use a separate AppleID for just Logisim Evolution.
# Also work on an entirely fresh Mac hardware and account, since the AppleID
# is engrained fairly thoroughly in MacOS.
# - jpackage (via Apple's pkgbuild/productbuild) does not set file permissions
# (chmod) correctly on the installed application by default. jpackage does not
# appear to have a way to pass custom arguments to pkgbuild/productbuild, and
# it isn't clear there are any options that would help (the "preserve file
# ownership" options might, but that doesn't say anything about preserving
# file permissions).
# Workaround: use a postinstall script to chmod all the files to reasonable
# permissions.
# - On my rarely-used mac, jpackage from jdk-14-ea-16 seems to have entirely
# disappeared, without a trace. Perhaps some auto update? The download links
# on oracle's site for that package are dead/404. The original download
# does not contain jpackage. The build scripts do not work without it.
# Workaround: Download and install new jdk-14-ea-32 release, which seems to
# have jpaackage again.
# - The new jpackage has renamed lots of options, so fix those below:
# '--package-type' is now '--type'
# '--output' is now '--dest'
# '--mac-bundle-identifier' is now '--mac-package-identifier'
# '--mac-bundle-name' is now '--mac-package-name'
# '--identifier' isn ow '--mac-package-signing-prefix'
# '--add-modules' and '--runtime-image' are now mutually exclusive, so
# eliminate the former.
# - Code signing may *appear* to fail with the new jpackage with an error like:
# Running [codesign, --verify, /var/folders/kb/zswdtzg94bs52lqrts5sssdr0000gp/T/jdk.incubator.jpackage13637540241510693609/images/image-5430644754281798291/Logisim-Evolution.app/Contents/MacOS/libapplauncher.dylib]
# /var/folders/kb/zswdtzg94bs52lqrts5sssdr0000gp/T/jdk.incubator.jpackage13637540241510693609/images/image-5430644754281798291/Logisim-Evolution.app/Contents/MacOS/libapplauncher.dylib: code object is not signed at all
# In architecture: x86_64
# Running [codesign, -s, Developer ID Application: Kevin Walsh (GDM3S3ULJA), --prefix, edu.holycross.cs.kwalsh.logisim, -vvvv, /var/folders/kb/zswdtzg94bs52lqrts5sssdr0000gp/T/jdk.incubator.jpackage13637540241510693609/images/image-5430644754281798291/Logisim-Evolution.app/Contents/MacOS/libapplauncher.dylib]
# error: The specified item could not be found in the keychain.
# java.io.IOException: Command [codesign, -s, Developer ID Application: Kevin Walsh (GDM3S3ULJA), --prefix, edu.holycross.cs.kwalsh.logisim, -vvvv, /var/folders/kb/zswdtzg94bs52lqrts5sssdr0000gp/T/jdk.incubator.jpackage13637540241510693609/images/image-5430644754281798291/Logisim-Evolution.app/Contents/MacOS/libapplauncher.dylib] exited with 1 code
# at jdk.incubator.jpackage/jdk.incubator.jpackage.internal.Executor.executeExpectSuccess(Executor.java:73)
# at jdk.incubator.jpackage/jdk.incubator.jpackage.internal.IOUtils.exec(IOUtils.java:179)
# at jdk.incubator.jpackage/jdk.incubator.jpackage.internal.IOUtils.exec(IOUtils.java:150)
# at jdk.incubator.jpackage/jdk.incubator.jpackage.internal.MacAppImageBuilder.lambda$signAppBundle$16(MacAppImageBuilder.java:804)
# This, however, just means that the Developer ID Application and Developer ID Installer keys (not the certificates)
# are missing from the keychain. This can be fixed by going into XCode, preferences, Keys, and create a new one of each.
# Or, for x86 Macs, since XCode isn't available for that platform, from a Mac with the needed keys in the keychain, export
# the keys (using a password to encrypt the files), copy the key files over to the x86 Mac, import them to the login keychain,
# and try again.
set -e # die on error
#set -x # debug output
arch=`uname -m`
if [ "$arch" == "arm64" ]; then
ARCH_SUFFIX=""
echo "#### Building MacOS release for arm64 (newer m1, m2, etc.)"
elif [ "$arch" == "x86_64" ]; then
ARCH_SUFFIX="-x86"
echo "#### Building MacOS release for x86 (older platforms)"
else
echo "Unrecognized system architecture"
exit 1
fi
# Using list-deps is recommended by one tutorial, but it seems to over-estimate
# the modules needed. Perhaps it (harmlessly)includes transitive dependencies?
# MODULES=`jdeps --list-deps logisim-evolution.jar | paste -d, -s`
# MODULES=java.base,java.datatransfer,java.desktop,java.logging,java.prefs,java.xml
# Using print-module-deps appears to be the correct way to get the dependencies.
echo "Detecting java module dependencies..."
DETECTED_MODULES=`jdeps --print-module-deps logisim-evolution.jar`
MODULES="java.base,java.desktop,java.logging,java.prefs,jdk.httpserver"
echo "Detected java module dependencies: ${DETECTED_MODULES}"
JAVA_RUNTIME="java-runtime-mac"
if [ "${DETECTED_MODULES}" != "${MODULES}" ]; then
echo "ERROR: This differs from expected!"
echo " : Module dependencies must have changed!"
echo " : Within build-packager.sh, set MODULES=\"${DETECTED_MODULES}\""
echo " : Then delete ./${JAVA_RUNTIME} and try running this again."
exit 1
fi
if [ ! -e "${JAVA_RUNTIME}" ]; then
echo "Building custom java runtime (using jlink)..."
jlink --no-header-files --no-man-pages --compress=2 --strip-debug \
--add-modules "${MODULES}" --output "${JAVA_RUNTIME}"
else
echo "Using previously-built custom java runtime (from jlink)."
fi
INSTALLER_TYPE="pkg" # Options: dmg or pkg
OUTPUT="."
JAR="logisim-evolution.jar"
VERSION="5.0.4" # must be numerical x.y.z
FILE_ASSOCIATIONS="file-associations.properties"
APP_ICON="logisim.icns"
JAVA_APP_IDENTIFIER="edu.holycross.cs.kwalsh.logisim"
# Prepare input files
echo "Preparing input files..."
rm -rf mac-staging
mkdir -p mac-staging
cp LICENSE "${JAR}" mac-staging/
# Prepare installer customizations: background image, postinstall script
echo "Preparing installer customizations..."
rm -rf mac-resources
mkdir -p mac-resources
cp mac-installer-background.png mac-resources/Logisim-Evolution-background.png
cat <<END >> mac-resources/postinstall
#!/bin/bash
chmod -R go+rX INSTALL_LOCATION/Logisim-Evolution.app
END
chmod a+rx mac-resources/postinstall
# Build the app and installer package
echo "Building ${INSTALLER_TYPE} ..."
PACKAGER=/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home/bin/jpackage
${PACKAGER} \
--type ${INSTALLER_TYPE} \
--input mac-staging \
--dest "${OUTPUT}" \
--name "Logisim-Evolution" \
--main-class com.cburch.logisim.Main \
--main-jar "${JAR}" \
--java-options "--add-opens=java.desktop/com.apple.eawt.event=ALL-UNNAMED" \
--app-version "${VERSION}" \
--copyright "(c) 2025 Kevin Walsh" \
--description "Digital logic designer and simulator." \
--vendor "Kevin Walsh" \
--runtime-image "${JAVA_RUNTIME}" \
--icon "${APP_ICON}" \
--mac-package-identifier "Logisim-Evolution-HC" \
--mac-package-name "Logisim HC" \
--mac-sign \
--file-associations "${FILE_ASSOCIATIONS}" \
--mac-package-signing-prefix "${JAVA_APP_IDENTIFIER}" \
--resource-dir mac-resources \
--license-file LICENSE \
--verbose
# --add-modules "${MODULES}"
rm -rf mac-staging
rm -rf mac-resources
mv "Logisim-Evolution-${VERSION}.pkg" "Logisim-Evolution-${VERSION}-HC${ARCH_SUFFIX}.pkg"
cat <<ENDNOTE
# To notarize, run this command:
ALTOOLPW=enter-app-specific-password-here
xcrun notarytool submit \
--apple-id "[email protected]" --team-id "GDM3S3ULJA" --password "\$ALTOOLPW" \
Logisim-Evolution-${VERSION}-HC${ARCH_SUFFIX}.pkg
# Then later, try:
xcrun notarytool history \
--apple-id "[email protected]" --team-id "GDM3S3ULJA" --password "\$ALTOOLPW"
# And if that works, then try:
SUBMISSION_ID=whatever-from-previous-command
xcrun notarytool info \
--apple-id "[email protected]" --team-id "GDM3S3ULJA" --password "\$ALTOOLPW" \
"\$SUBMISSION_ID"
# And if that works, then try:
xcrun notarytool log \
--apple-id "[email protected]" --team-id "GDM3S3ULJA" --password "\$ALTOOLPW" \
"\$SUBMISSION_ID" > mac-notarize${ARCH_SUFFIX}.log
cat mac-notarize${ARCH_SUFFIX}.log
# Check for warnings and errors, then finally:
xcrun stapler staple Logisim-Evolution-${VERSION}-HC${ARCH_SUFFIX}.pkg
ENDNOTE