mirrors/bisq
1
0
Fork 0
mirror of https://github.com/bisq-network/bisq.git synced 2024-11-19 09:52:23 +01:00
Code Issues Packages Projects Releases Wiki Activity
33297c865a
bisq/desktop/package/package.gradle

432 lines
21 KiB
Groovy
Raw Normal View History

Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
import java.time.LocalDateTime
import org.apache.tools.ant.taskdefs.condition.Os
import static groovy.io.FileType.*
task jpackageSanityChecks {
description 'Interactive sanity checks on the version of the code that will be packaged'
doLast {
executeCmd("git --no-pager log -5 --oneline")
ant.input(message: "Above you see the current HEAD and its recent history.\n" +
"Is this the right commit for packaging? (y=continue, n=abort)",
addproperty: "sanity-check-1",
validargs: "y,n")
if (ant.properties['sanity-check-1'] == 'n') {
ant.fail('Aborting')
}
executeCmd("git status --short --branch")
ant.input(message: "Above you see any local changes that are not in the remote branch.\n" +
"If you have any local changes, please abort, get them merged, get the latest branch and try again.\n" +
"Continue with packaging? (y=continue, n=abort)",
addproperty: "sanity-check-2",
validargs: "y,n")
if (ant.properties['sanity-check-2'] == 'n') {
ant.fail('Aborting')
}
// TODO Evtl check programmatically in gradle (i.e. fail if below v11)
executeCmd("java --version")
ant.input(message: "Above you see the installed java version, which will be used to compile and build Bisq.\n" +
"Is this java version ok for that? (y=continue, n=abort)",
addproperty: "sanity-check-3",
validargs: "y,n")
if (ant.properties['sanity-check-3'] == 'n') {
ant.fail('Aborting')
}
}
}
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
task getJavaBinariesDownloadURLs {
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
description 'Find out which JDK will be used for jpackage and prepare to download it'
dependsOn 'jpackageSanityChecks'
doLast {
// The build directory will be deleted next time the clean task runs
// Therefore, we can use it to store any temp files (separate JDK for jpackage, etc) and resulting build artefacts
// We create a temp folder in the build directory which holds all jpackage-related artefacts (not just the final installers)
Make temp folder name more readable Change packaging temp folder name from a random string to a timestamp.
2020-12-13 14:25:10 +01:00
String tempRootDirName = 'temp-' + LocalDateTime.now().format('yyyy.MM.dd-HHmmssSSS')
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
File tempRootDir = new File(project.buildDir, tempRootDirName)
tempRootDir.mkdirs()
ext.tempRootDir = tempRootDir
println "Created temp root folder " + tempRootDir
File binariesFolderPath = new File(tempRootDir, "binaries")
binariesFolderPath.mkdirs();
ext.binariesFolderPath = binariesFolderPath
// TODO Extend script logic to alternatively allow a local (separate, v14+) JDK for jpackage
// TODO Another option is to use the local JDK for everything: build jars and use jpackage (but then it has to be v14+)
Add checksum verification for downloaded JDK binaries Verify downloaded JDK binary hash against list of known (expected) hash values for the different JDK versions and OS platforms.
2020-12-04 13:39:48 +01:00
// Define the download URLs (and associated binary hashes) for the JDK used to package the installers
// These JDKs are independent of what is installed on the building system
//
// If these specific versions are not hosted by AdoptOpenJDK anymore, or if different versions are desired,
// simply update the links and associated hashes below
//
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
// See https://adoptopenjdk.net/releases.html?variant=openjdk15&jvmVariant=hotspot for latest download URLs
Add checksum verification for downloaded JDK binaries Verify downloaded JDK binary hash against list of known (expected) hash values for the different JDK versions and OS platforms.
2020-12-04 13:39:48 +01:00
// On the download page linked above, filter as follows to get the binary URL + associated SHA256:
// - architecture: x64
// - operating system:
// -- linux ( -> use the tar.gz JDK link)
// -- macOS ( -> use the tar.gz JDK link)
// -- windows ( -> use the .zip JDK link)
Map jdk15Binaries = [
'linux' : 'https://github.com/AdoptOpenJDK/openjdk15-binaries/releases/download/jdk-15.0.1%2B9/OpenJDK15U-jdk_x64_linux_hotspot_15.0.1_9.tar.gz',
'linux-sha256' : '61045ecb9434e3320dbc2c597715f9884586b7a18a56d29851b4d4a4d48a2a5e',
'mac' : 'https://github.com/AdoptOpenJDK/openjdk15-binaries/releases/download/jdk-15.0.1%2B9.1/OpenJDK15U-jdk_x64_mac_hotspot_15.0.1_9.tar.gz',
'mac-sha256' : 'b8c2e2ad31f3d6676ea665d9505b06df15e23741847556612b40e3ee329fc046',
'windows' : 'https://github.com/AdoptOpenJDK/openjdk15-binaries/releases/download/jdk-15.0.1%2B9/OpenJDK15U-jdk_x64_windows_hotspot_15.0.1_9.zip',
'windows-sha256' : '0cd7e61b0a37186902062a822caa0e14662b676c245b7ebe541f115f3c45681a'
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
// TODO For some reason, using "--runtime-image jdk-11" does NOT work with a v15 jpackage, but works with v14
// v14
Remove --runtime-image option using separate JDK Remove the --runtime-image jpackage option, which was packaging Java 11 in the resulting installers. Reason is that jpackage 15 does not properly package the Java 11 runtime, but contains necessary features for signing and notarizing the app. On the other hand, jpackage 14 does package the Java 11 runtime correctly in the resulting installers, but does not support proper signing and notarizing.
2020-10-08 13:29:40 +02:00
// 'linux' : 'https://github.com/AdoptOpenJDK/openjdk14-binaries/releases/download/jdk-14.0.2%2B12/OpenJDK14U-jdk_x64_linux_hotspot_14.0.2_12.tar.gz',
Add checksum verification for downloaded JDK binaries Verify downloaded JDK binary hash against list of known (expected) hash values for the different JDK versions and OS platforms.
2020-12-04 13:39:48 +01:00
// 'linux-sha256' : '7d5ee7e06909b8a99c0d029f512f67b092597aa5b0e78c109bd59405bbfa74fe',
Remove --runtime-image option using separate JDK Remove the --runtime-image jpackage option, which was packaging Java 11 in the resulting installers. Reason is that jpackage 15 does not properly package the Java 11 runtime, but contains necessary features for signing and notarizing the app. On the other hand, jpackage 14 does package the Java 11 runtime correctly in the resulting installers, but does not support proper signing and notarizing.
2020-10-08 13:29:40 +02:00
// 'mac' : 'https://github.com/AdoptOpenJDK/openjdk14-binaries/releases/download/jdk-14.0.2%2B12/OpenJDK14U-jdk_x64_mac_hotspot_14.0.2_12.tar.gz',
Add checksum verification for downloaded JDK binaries Verify downloaded JDK binary hash against list of known (expected) hash values for the different JDK versions and OS platforms.
2020-12-04 13:39:48 +01:00
// 'mac-sha256' : '09b7e6ab5d5eb4b73813f4caa793a0b616d33794a17988fa6a6b7c972e8f3dd3',
// 'windows' : 'https://github.com/AdoptOpenJDK/openjdk14-binaries/releases/download/jdk-14.0.2%2B12/OpenJDK14U-jdk_x64_windows_hotspot_14.0.2_12.zip',
// 'windows-sha256' : '80926003297bf5afc9357ce24c12aee65483fc7889dc34b65fe08bec4d040611'
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
]
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
String osKey
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
osKey = 'windows'
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
} else if (Os.isFamily(Os.FAMILY_MAC)) {
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
osKey = 'mac'
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
} else {
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
osKey = 'linux'
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
}
Add checksum verification for downloaded JDK binaries Verify downloaded JDK binary hash against list of known (expected) hash values for the different JDK versions and OS platforms.
2020-12-04 13:39:48 +01:00
ext.jdk15Binary_DownloadURL = jdk15Binaries[osKey]
ext.jdk15Binary_SHA256Hash = jdk15Binaries[osKey + '-sha256']
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
}
}
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
task retrieveAndExtractJavaBinaries {
description 'Retrieve necessary Java binaries and extract them'
dependsOn 'getJavaBinariesDownloadURLs'
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
doLast {
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
File tempRootDir = getJavaBinariesDownloadURLs.property("tempRootDir")
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
// Folder where the jpackage JDK archive will be downloaded and extracted
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
String jdkForJpackageDirName = "jdk-jpackage"
File jdkForJpackageDir = new File(tempRootDir, jdkForJpackageDirName)
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
jdkForJpackageDir.mkdirs();
Add checksum verification for downloaded JDK binaries Verify downloaded JDK binary hash against list of known (expected) hash values for the different JDK versions and OS platforms.
2020-12-04 13:39:48 +01:00
String jdkForJpackageArchiveURL = getJavaBinariesDownloadURLs.property('jdk15Binary_DownloadURL')
String jdkForJpackageArchiveHash = getJavaBinariesDownloadURLs.property('jdk15Binary_SHA256Hash')
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
String jdkForJpackageArchiveFileName = jdkForJpackageArchiveURL.tokenize('/').last()
File jdkForJpackageFile = new File(jdkForJpackageDir, jdkForJpackageArchiveFileName)
Add checksum verification for downloaded JDK binaries Verify downloaded JDK binary hash against list of known (expected) hash values for the different JDK versions and OS platforms.
2020-12-04 13:39:48 +01:00
// Download necessary JDK binaries + verify hash
ext.downloadAndVerifyArchive(jdkForJpackageArchiveURL, jdkForJpackageArchiveHash, jdkForJpackageFile)
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
// Extract them
String jpackageBinaryFileName
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
ext.extractArchiveZip(jdkForJpackageFile, jdkForJpackageDir)
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
jpackageBinaryFileName = 'jpackage.exe'
} else {
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
ext.extractArchiveTarGz(jdkForJpackageFile, jdkForJpackageDir)
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
jpackageBinaryFileName = 'jpackage'
}
// Find jpackage in the newly extracted JDK
// Don't rely on hardcoded paths to reach it, because the path depends on the version and platform
jdkForJpackageDir.traverse(type: FILES, nameFilter: jpackageBinaryFileName) {
println 'Using jpackage binary from ' + it
ext.jpackageFilePath = it.path
}
}
Add checksum verification for downloaded JDK binaries Verify downloaded JDK binary hash against list of known (expected) hash values for the different JDK versions and OS platforms.
2020-12-04 13:39:48 +01:00
ext.downloadAndVerifyArchive = {String archiveURL, String archiveSHA256, File destinationArchiveFile ->
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
println "Downloading ${archiveURL}"
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
ant.get(src: archiveURL, dest: destinationArchiveFile)
println 'Download saved to ' + destinationArchiveFile
Add checksum verification for downloaded JDK binaries Verify downloaded JDK binary hash against list of known (expected) hash values for the different JDK versions and OS platforms.
2020-12-04 13:39:48 +01:00
println 'Verifying checksum for downloaded binary ...'
ant.jdkHash = archiveSHA256
ant.checksum(file: destinationArchiveFile, algorithm: 'SHA-256', property: '${jdkHash}', verifyProperty: 'hashMatches')
if (ant.properties['hashMatches'] != 'true') {
ant.fail('Checksum mismatch: Downloaded JDK binary has a different checksum than expected')
}
println 'Checksum verified'
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
}
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
ext.extractArchiveTarGz = {File tarGzFile, File destinationDir ->
println "Extracting tar.gz ${tarGzFile}"
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
// Gradle's tar extraction preserves permissions (crucial for jpackage to function correctly)
copy {
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
from tarTree(resources.gzip(tarGzFile))
into destinationDir
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
}
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
println "Extracted to ${destinationDir}"
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
}
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
ext.extractArchiveZip = {File zipFile, File destinationDir ->
println "Extracting zip ${zipFile}..."
ant.unzip(src: zipFile, dest: destinationDir)
println "Extracted to ${destinationDir}"
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
}
}
task packageInstallers {
description 'Call jpackage to prepare platform-specific binaries for this platform'
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
dependsOn 'retrieveAndExtractJavaBinaries'
Fix JDK v15 installer download URL Fix the logic used to determine the JDK 15 assets and download links. Pre-releases are now excluded, as well as openj9 binaries. The resulting assets are final releases of hotspot builds.
2020-09-26 12:02:15 +02:00
// Clean all previous artefacts and create a fresh shadowJar for the installers
dependsOn rootProject.clean
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
dependsOn ':desktop:shadowJar'
doLast {
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
String jPackageFilePath = retrieveAndExtractJavaBinaries.property('jpackageFilePath')
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
String licenseFilePath = "${rootProject.projectDir}/LICENSE"
Add support for jdk11 runtime-image Update jpackage arguments such that a specific java version is packaged in the installers (in this case, v11).
2020-09-26 15:31:50 +02:00
File binariesFolderPath = file(getJavaBinariesDownloadURLs.property('binariesFolderPath'))
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
Fix macOS dmg background image Update macOS setup script to use the tiff image in the installer bundle, as this is the type of background image expected and included by jpackage. Convert Bisq-background.png to Bisq-background.tiff using imagemagick.
2020-10-04 22:14:12 +02:00
File tempRootDir = getJavaBinariesDownloadURLs.property("tempRootDir")
// The jpackateTempDir stores temp files used by jpackage for building the installers
// It can be inspected in order to troubleshoot the packaging process
File jpackateTempDir = new File(tempRootDir, "jpackage-temp")
jpackateTempDir.mkdirs();
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
// ALL contents of this folder will be included in the resulting installers
// However, the fat jar is the only one we need
// Therefore, this location should point to a folder that ONLY contains the fat jar
// If later we will need to include other non-jar resources, we can do that by adding --resource-dir to the jpackage opts
String fatJarFolderPath = "${project(':desktop').buildDir}/libs"
String mainJarName = file(fatJarFolderPath).list()[0]
// TODO For non-modular applications: use jlink to create a custom runtime containing only the modules required
// See jpackager argument documentation:
// https://docs.oracle.com/en/java/javase/15/docs/specs/man/jpackage.html
Linux: Improve package names The generated package names include, by convention, two version numbers: the app version and the package version. The first one is set to the Bisq software version, the second is now set to 1. The resulting package names are: - bisq_1.5.0-1_amd64.deb - bisq-1.5.0-1.x86_64.rpm
2020-12-03 16:23:58 +01:00
// Remove the -SNAPSHOT suffix from the version string (originally defined in build.gradle)
// Having it in would have resulted in an invalid version property for several platforms (mac, linux/rpm)
String appVersion = version.replaceAll("-SNAPSHOT", "")
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
println "Packaging Bisq version ${appVersion}"
Fix jpackage option concatenation Fixed typo affecting jpackage option concatenation, where a missing "+" caused subsequent options to not be considered. Surround concatenated options with parentheses, to ensure such a typo in the future is marked as a syntax error, and therefore avoided.
2020-10-04 12:16:29 +02:00
String commonOpts = (
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
// Generic options
" --dest \"${binariesFolderPath}\"" +
Fix macOS dmg background image Update macOS setup script to use the tiff image in the installer bundle, as this is the type of background image expected and included by jpackage. Convert Bisq-background.png to Bisq-background.tiff using imagemagick.
2020-10-04 22:14:12 +02:00
" --name Bisq" +
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
" --description \"A decentralized bitcoin exchange network.\"" +
" --app-version ${appVersion}" +
" --copyright \"© 2020 Bisq\"" +
" --vendor Bisq" +
Fix macOS dmg background image Update macOS setup script to use the tiff image in the installer bundle, as this is the type of background image expected and included by jpackage. Convert Bisq-background.png to Bisq-background.tiff using imagemagick.
2020-10-04 22:14:12 +02:00
" --temp \"${jpackateTempDir}\"" +
Disable '-Djdk.module.illegalAccess=deny' javaoption Disable the java option because it causes issues in the resulting app if packaged with a recent Java Runtime (tested with Java 11, 14 and 15).
2020-10-08 13:15:08 +02:00
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
// Options for creating the application image
" --input ${fatJarFolderPath}" +
Disable '-Djdk.module.illegalAccess=deny' javaoption Disable the java option because it causes issues in the resulting app if packaged with a recent Java Runtime (tested with Java 11, 14 and 15).
2020-10-08 13:15:08 +02:00
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
// Options for creating the application launcher
" --main-jar ${mainJarName}" +
" --main-class bisq.desktop.app.BisqAppMain" +
" --java-options -Xss1280k" +
" --java-options -XX:MaxRAM=4g" +
" --java-options -Djava.net.preferIPv4Stack=true" +
Disable '-Djdk.module.illegalAccess=deny' javaoption Disable the java option because it causes issues in the resulting app if packaged with a recent Java Runtime (tested with Java 11, 14 and 15).
2020-10-08 13:15:08 +02:00
// Warning: this will cause guice reflection exceptions and lead to issues with the guice internal cache
// resulting in the UI not loading
// " --java-options -Djdk.module.illegalAccess=deny" +
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
// Options for creating the application package
Remove --runtime-image option using separate JDK Remove the --runtime-image jpackage option, which was packaging Java 11 in the resulting installers. Reason is that jpackage 15 does not properly package the Java 11 runtime, but contains necessary features for signing and notarizing the app. On the other hand, jpackage 14 does package the Java 11 runtime correctly in the resulting installers, but does not support proper signing and notarizing.
2020-10-08 13:29:40 +02:00
" --license-file \"${licenseFilePath}\""
Fix jpackage option concatenation Fixed typo affecting jpackage option concatenation, where a missing "+" caused subsequent options to not be considered. Surround concatenated options with parentheses, to ensure such a typo in the future is marked as a syntax error, and therefore avoided.
2020-10-04 12:16:29 +02:00
)
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
Update jpackage comment for Windows
2020-10-23 20:13:09 +02:00
// TODO Found no benefit in using --resource-dir "..package/windows", it has the same outcome as opts below
// Actually using the --resource-dir option caused issues with uninstalling the newly installed Bisq
// Therefore, not using --resource-dir for windows, for now
Fix jpackage option concatenation Fixed typo affecting jpackage option concatenation, where a missing "+" caused subsequent options to not be considered. Surround concatenated options with parentheses, to ensure such a typo in the future is marked as a syntax error, and therefore avoided.
2020-10-04 12:16:29 +02:00
String windowsOpts = (
" --icon ${project(':desktop').projectDir}/package/windows/Bisq.ico" +
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
" --win-per-user-install" +
" --win-menu" +
Remove jpackage Windows TODO Remove TODO, since previous argument concatenation fix addressed the issue (desktop and start menu shortcuts are created now).
2020-10-04 12:56:34 +02:00
" --win-shortcut"
Fix jpackage option concatenation Fixed typo affecting jpackage option concatenation, where a missing "+" caused subsequent options to not be considered. Surround concatenated options with parentheses, to ensure such a typo in the future is marked as a syntax error, and therefore avoided.
2020-10-04 12:16:29 +02:00
)
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
// TODO How does the current package/windows/Bisq.iss play into this?
executeCmd(jPackageFilePath + commonOpts + windowsOpts + " --type exe")
} else if (Os.isFamily(Os.FAMILY_MAC)) {
Fix macOS dmg background image Update macOS setup script to use the tiff image in the installer bundle, as this is the type of background image expected and included by jpackage. Convert Bisq-background.png to Bisq-background.tiff using imagemagick.
2020-10-04 22:14:12 +02:00
// See https://docs.oracle.com/en/java/javase/14/jpackage/override-jpackage-resources.html
// for details of "--resource-dir"
Fix jpackage option concatenation Fixed typo affecting jpackage option concatenation, where a missing "+" caused subsequent options to not be considered. Surround concatenated options with parentheses, to ensure such a typo in the future is marked as a syntax error, and therefore avoided.
2020-10-04 12:16:29 +02:00
String macOpts = (
Fix macOS dmg background image Update macOS setup script to use the tiff image in the installer bundle, as this is the type of background image expected and included by jpackage. Convert Bisq-background.png to Bisq-background.tiff using imagemagick.
2020-10-04 22:14:12 +02:00
" --resource-dir \"${project(':desktop').projectDir}/package/macosx\""
Fix jpackage option concatenation Fixed typo affecting jpackage option concatenation, where a missing "+" caused subsequent options to not be considered. Surround concatenated options with parentheses, to ensure such a typo in the future is marked as a syntax error, and therefore avoided.
2020-10-04 12:16:29 +02:00
)
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
macOS: Read signing identity from environment variable Read the macOS signing identity from the user's environment variable.
2020-12-14 17:13:24 +01:00
// Env variable can be set by calling "export BISQ_PACKAGE_SIGNING_IDENTITY='Some value'"
// See "man codesign" for details about the expected signing identity
String envVariableSigningID = "$System.env.BISQ_PACKAGE_SIGNING_IDENTITY"
println "Environment variable BISQ_PACKAGE_SIGNING_IDENTITY is: ${envVariableSigningID}"
macOS: Sign app-image and bundle when packaging Update the macOS packaging process with the ncessary steps to sign the app-image and the final dmg package.
2020-12-16 17:31:44 +01:00
ant.input(message: "Sign the app using the above signing identity? (y=yes, n=no)",
macOS: Add optional step to sign dylibs Extend macOS packaging process with optional y/n step where relevant dylibs are extracted, signed, and re-added back to the shadow jar, before packaging it into the final app.
2020-12-13 18:04:10 +01:00
addproperty: "macos-sign-check",
validargs: "y,n")
if (ant.properties['macos-sign-check'] == 'y') {
// Create a temp folder to extract the macos-specific dylibs that need to be signed
File tempDylibFolderPath = new File(tempRootDir, "dylibs-to-sign")
tempDylibFolderPath.mkdirs();
// Dylibs relevant for signing (paths relative to the tempDylibFolderPath)
String dylibsToSign = (
" libjavafx_iio.dylib" +
" libglass.dylib" +
" libjavafx_font.dylib" +
" libprism_common.dylib" +
" libprism_es2.dylib" +
" libdecora_sse.dylib" +
" libprism_sw.dylib" +
" org/bridj/lib/darwin_universal/libbridj.dylib" +
" META-INF/native/libio_grpc_netty_shaded_netty_tcnative_osx_x86_64.jnilib" +
" lib/x86_64/darwin/libscrypt.dylib" +
" com/github/sarxos/webcam/ds/buildin/lib/darwin_universal/libOpenIMAJGrabber.dylib"
)
macOS: Sign app-image and bundle when packaging Update the macOS packaging process with the ncessary steps to sign the app-image and the final dmg package.
2020-12-16 17:31:44 +01:00
// macOS step 1: Sign dylibs and replace them in the shadow jar
macOS: Add optional step to sign dylibs Extend macOS packaging process with optional y/n step where relevant dylibs are extracted, signed, and re-added back to the shadow jar, before packaging it into the final app.
2020-12-13 18:04:10 +01:00
// Extract dylibss for signing
executeCmd("cd ${tempDylibFolderPath} &&" +
" jar xf ${fatJarFolderPath}/${mainJarName}" +
dylibsToSign)
// Sign them
executeCmd("cd ${tempDylibFolderPath} &&" +
macOS: Read signing identity from environment variable Read the macOS signing identity from the user's environment variable.
2020-12-14 17:13:24 +01:00
" codesign -vvv --options runtime --deep --force --sign \"${envVariableSigningID}\"" +
macOS: Add optional step to sign dylibs Extend macOS packaging process with optional y/n step where relevant dylibs are extracted, signed, and re-added back to the shadow jar, before packaging it into the final app.
2020-12-13 18:04:10 +01:00
dylibsToSign)
// Replace unsigned files in jar file
executeCmd("cd ${tempDylibFolderPath} &&" +
" jar uf ${fatJarFolderPath}/${mainJarName}" +
dylibsToSign)
macOS: Sign app-image and bundle when packaging Update the macOS packaging process with the ncessary steps to sign the app-image and the final dmg package.
2020-12-16 17:31:44 +01:00
// macOS step 2: Build app-image using the shadow jar above (containing signed dylibs)
// NOTE: licensing file cannot be added at this point only when creating the dmg later
executeCmd(jPackageFilePath +
" --dest \"${binariesFolderPath}\"" +
" --name Bisq" +
" --description \"A decentralized bitcoin exchange network.\"" +
" --app-version ${appVersion}" +
" --copyright \"© 2020 Bisq\"" +
" --vendor Bisq" +
" --temp \"${jpackateTempDir}\"" +
" --input ${fatJarFolderPath}" +
" --main-jar ${mainJarName}" +
" --main-class bisq.desktop.app.BisqAppMain" +
" --java-options -Xss1280k" +
" --java-options -XX:MaxRAM=4g" +
" --java-options -Djava.net.preferIPv4Stack=true" +
macOpts +
" --type app-image")
// macOS step 3: Sign app (hardended runtime)
File bisqAppImageFullPath = new File(binariesFolderPath, "Bisq.app")
executeCmd("codesign" +
" --sign \"${envVariableSigningID}\"" +
" --options runtime" +
macOS: Include entitlements plist Add the entitlements mapping file needed for the signing process.
2020-12-21 16:39:25 +01:00
" --entitlements '${project(':desktop').projectDir}/package/macosx/macos.entitlements'" +
macOS: Sign app-image and bundle when packaging Update the macOS packaging process with the ncessary steps to sign the app-image and the final dmg package.
2020-12-16 17:31:44 +01:00
" --force" +
" --verbose" +
"${bisqAppImageFullPath}/Contents/runtime/Contents/MacOS/libjli.dylib")
executeCmd("codesign" +
" --sign \"${envVariableSigningID}\"" +
" --options runtime" +
macOS: Include entitlements plist, part 2 Include the full path to the entitlements mapping file in all codesign calls.
2020-12-21 16:48:46 +01:00
" --entitlements '${project(':desktop').projectDir}/package/macosx/macos.entitlements'" +
macOS: Sign app-image and bundle when packaging Update the macOS packaging process with the ncessary steps to sign the app-image and the final dmg package.
2020-12-16 17:31:44 +01:00
" --force" +
" --verbose" +
"${bisqAppImageFullPath}/Contents/MacOS/Bisq")
executeCmd("codesign" +
" --sign \"${envVariableSigningID}\"" +
" --options runtime" +
macOS: Include entitlements plist, part 2 Include the full path to the entitlements mapping file in all codesign calls.
2020-12-21 16:48:46 +01:00
" --entitlements '${project(':desktop').projectDir}/package/macosx/macos.entitlements'" +
macOS: Sign app-image and bundle when packaging Update the macOS packaging process with the ncessary steps to sign the app-image and the final dmg package.
2020-12-16 17:31:44 +01:00
" --force" +
" --verbose" +
" ${bisqAppImageFullPath}")
// macOS step 4: Package the app-image into a dmg bundle
executeCmd(jPackageFilePath +
" --dest \"${binariesFolderPath}\"" +
" --name Bisq" +
" --description \"A decentralized bitcoin exchange network.\"" +
" --app-version ${appVersion}" +
" --copyright \"© 2020 Bisq\"" +
" --vendor Bisq" +
" --temp \"${jpackateTempDir}\"" +
" --app-image ${bisqAppImageFullPath}" +
" --license-file \"${licenseFilePath}\"" +
" --mac-sign" +
" --type dmg")
// macOS step 5: Sign dmg bundle
executeCmd("codesign" +
" --sign \"${envVariableSigningID}\"" +
" --options runtime" +
" --entitlements '${binariesFolderPath}/macos.entitlements'" +
" -vvvv" +
" --deep" +
" '${binariesFolderPath}/Bisq-${appVersion}.dmg'")
} else {
// If user didn't confirm the optional signing step, then generate a plain non-signed dmg
executeCmd(jPackageFilePath + commonOpts + macOpts + " --type dmg")
}
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
} else {
Fix jpackage option concatenation Fixed typo affecting jpackage option concatenation, where a missing "+" caused subsequent options to not be considered. Surround concatenated options with parentheses, to ensure such a typo in the future is marked as a syntax error, and therefore avoided.
2020-10-04 12:16:29 +02:00
String linuxOpts = (
" --icon ${project(':desktop').projectDir}/package/linux/icon.png" +
Linux: Improve package names The generated package names include, by convention, two version numbers: the app version and the package version. The first one is set to the Bisq software version, the second is now set to 1. The resulting package names are: - bisq_1.5.0-1_amd64.deb - bisq-1.5.0-1.x86_64.rpm
2020-12-03 16:23:58 +01:00
// This defines the first part of the resulting packages (the application name)
// deb requires lowercase letters, therefore the application name is written in lowercase
" --linux-package-name bisq" +
// This represents the linux package version (revision)
// By convention, this is part of the deb/rpm package names, in addition to the software version
" --linux-app-release 1" +
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
" --linux-menu-group Network" +
" --linux-shortcut"
Fix jpackage option concatenation Fixed typo affecting jpackage option concatenation, where a missing "+" caused subsequent options to not be considered. Surround concatenated options with parentheses, to ensure such a typo in the future is marked as a syntax error, and therefore avoided.
2020-10-04 12:16:29 +02:00
)
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
Fix issue when building deb and rpm at the same time Fixed an issue in the Linux section, which didn't allow building both rpm and deb packages at the same time.
2020-12-03 13:07:38 +01:00
// Package deb
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
executeCmd(jPackageFilePath + commonOpts + linuxOpts +
" --linux-deb-maintainer contact@bisq.network" +
" --type deb")
Fix issue when building deb and rpm at the same time Fixed an issue in the Linux section, which didn't allow building both rpm and deb packages at the same time.
2020-12-03 13:07:38 +01:00
// Clean jpackage temp folder, needs to be empty for the next packaging step (rpm)
jpackateTempDir.deleteDir();
jpackateTempDir.mkdirs();
// Package rpm
Integrate jpackage to build platform-specific binaries Extend the gradle script with tasks that use jpackage to generate Bisq binaries. The kind of binaries generated depend on the OS where this is executed. The packaging of binaries can be started by calling: ./gradlew --console=plain packageInstallers from the root project folder.
2020-09-22 18:18:28 +02:00
executeCmd(jPackageFilePath + commonOpts + linuxOpts +
" --linux-rpm-license-type AGPLv3" + // https://fedoraproject.org/wiki/Licensing:Main?rd=Licensing#Good_Licenses
" --type rpm")
}
println "The binaries are ready:"
binariesFolderPath.traverse {
println it.path
}
}
}
def executeCmd(String cmd) {
String shell
String shellArg
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
shell = 'cmd'
shellArg = '/c'
} else {
shell = 'bash'
shellArg = '-c'
}
println "Executing command:\n${cmd}\n"
// See "Executing External Processes" section of
// http://docs.groovy-lang.org/next/html/documentation/
def commands = [shell, shellArg, cmd]
def process = commands.execute(null, project.rootDir)
if (process.waitFor() == 0) {
println "Command output (stdout):\n${process.text}"
} else {
println "Command output (stderr):\n${process.err.text}"
}
}
Reference in New Issue Copy Permalink