gino0631/pkg

A pure Java implementation of tools for building macOS installer packages.

pkg's Issues

Suggestion to avoid NPE

Instead of throwing a NPE when user set empty parameter like <conclusion/> into their POM ignore the field.

I don't mean that living empty parameter in the POM is fine, just that NPE never look good to me.

Add Welcome entry in the Distribution

I didn't see a way to customize the welcome message but i could have missed it.
https://developer.apple.com/library/archive/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html

NullPointerException

I'm trying to make a build test but i get that error:

[DEBUG] Configuring mojo com.github.gino0631:pkg-maven-plugin:1.1:product from plugin realm ClassRealm[plugin>com.github.gino0631:pkg-maven-plugin:1.1, parent: sun.misc.Launcher$AppClassLoader@10dea4e]
[DEBUG] Configuring mojo 'com.github.gino0631:pkg-maven-plugin:1.1:product' with basic configurator -->
[DEBUG]   (f) buildDirectory = F:\DigitalMediaServer\target
[DEBUG]   (f) alignment = bottomLeft
[DEBUG]   (f) scaling = proportional
[DEBUG]   (s)  = F:\DigitalMediaServer/src/main/resources/images/splash.png
[DEBUG]   (f) resources = [com.github.gino0631.pkg.maven.Resource@90265a]
[DEBUG]   (f) background = com.github.gino0631.pkg.maven.Background@32191e
[DEBUG]   (s)  = F:\DigitalMediaServer/src/main/external-resources/osx/license.rtf
[DEBUG]   (f) file = F:\DigitalMediaServer/src/main/external-resources/osx/gpl-2.0-fr.rtf
[DEBUG]   (f) lang = fr
[DEBUG]   (f) resources = [com.github.gino0631.pkg.maven.Resource@1accff0, com.github.gino0631.pkg.maven.Resource@559a69]
[DEBUG]   (f) license = com.github.gino0631.pkg.maven.License@5583d4
[DEBUG]   (s)  = F:\DigitalMediaServer/src/main/external-resources/readme.rtf
[DEBUG]   (f) readme = com.github.gino0631.pkg.maven.Readme@185217c
[DEBUG]   (s)  = F:\DigitalMediaServer/src/main/external-resources/conclusion.rtf
[DEBUG]   (f) conclusion = com.github.gino0631.pkg.maven.Conclusion@1b202ff
[DEBUG]   (f) distribution = com.github.gino0631.pkg.maven.Distribution@a84a12
[DEBUG]   (f) outputFile = DigitalMediaServer-0.0.2-SNAPSHOT.pkg
[DEBUG]   (f) packageIdentifier = org.digitalmediaserver.dms.pkg
[DEBUG]   (f) packageTitle = Digital Media Server
[DEBUG]   (f) packageVersion = 0.0.2-SNAPSHOT
[DEBUG]   (f) includes = [**/*.sh]
[DEBUG]   (f) excludes = []
[DEBUG]   (f) fileMode = 493
[DEBUG]   (f) permissionSets = [com.github.gino0631.pkg.maven.PermissionSet@cc02bb]
[DEBUG]   (f) root = F:\DigitalMediaServer\target\dms-macosx-x64
[DEBUG] -- end configuration --
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 01:56 min
[INFO] Finished at: 2018-05-24T00:52:14+02:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal com.github.gino0631:pkg-maven-plugin:1.1:product (create-macosx-pkg) on project dms: Execution create-macosx-pkg of goal com.github.gino0631:pkg-maven-plugin:1.1:product failed.: NullPointerException -> [Help 1]
org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal com.github.gino0631:pkg-maven-plugin:1.1:product (create-macosx-pkg) on project dms: Execution create-macosx-pkg of goal com.github.gino0631:pkg-maven-plugin:1.1:product failed.
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:213)

I suspect that i'm doing something wrong so any help is welcome ;)
Here is the my pom.xml:

                         <build>
				<plugins>
					<plugin>
						<groupId>org.apache.maven.plugins</groupId>
						<artifactId>maven-antrun-plugin</artifactId>
						<executions>
							<execution>
								<id>create-dir-macos</id>
								<phase>process-resources</phase>
								<goals>
									<goal>run</goal>
								</goals>
								<configuration>
									<target>
										<mkdir dir="${project.build.directory}/${project.artifactId}-macosx-x64" />
										<chmod dir="${project.build.directory}/${project.artifactId}-macosx-x64" type="dir" perm="0755"/>
									</target>
								</configuration>
							</execution>
						</executions>
					</plugin>
					<plugin>
						<groupId>com.github.gino0631</groupId>
						<artifactId>pkg-maven-plugin</artifactId>
						<version>1.1</version>
						<executions>
							<execution>
								<id>create-macosx-pkg</id>
								<phase>package</phase>
								<goals>
									<goal>product</goal>
								</goals>
								<configuration>
									<root>${project.build.directory}/${project.artifactId}-macosx-x64</root>
									<outputFile>${project.name.camel}-${project.version}.pkg</outputFile>
									<packageIdentifier>${project.groupId}.${project.artifactId}.pkg</packageIdentifier>
									<packageVersion>${project.version}</packageVersion>
									<packageTitle>${project.name}</packageTitle>
									<distribution>
										<background>
											<alignment>bottomLeft</alignment>
											<scaling>proportional</scaling>
											<resources>
												<resource>${project.basedir}/src/main/resources/images/splash.png</resource>
											</resources>
										</background>
										<license>
											<resources>
												<resource>${project.basedir}/src/main/external-resources/osx/license.rtf</resource>
												<resource>
													<file>${project.basedir}/src/main/external-resources/osx/gpl-2.0-fr.rtf</file>
													<lang>fr</lang>
												</resource>
											</resources>
										</license>
										<readme>${project.basedir}/src/main/external-resources/readme.rtf</readme>
										<conclusion>${project.basedir}/src/main/external-resources/conclusion.rtf</conclusion>
									</distribution>
									<permissionSets>
										<permissionSet>
											<includes>
												<include>**/*.sh</include>
											</includes>
											<excludes />
											<fileMode>0755</fileMode>
											<directoryMode />
											<uid />
											<gid />
										</permissionSet>
									</permissionSets>
									<!--
									<signing>
										<keystore>${project.basedir}/../dms.p12</keystore>
										<storetype>PKCS12</storetype>
										<storepass>${project.name.camel}</storepass>
										<tsa>http://timestamp.apple.com/ts01</tsa>
										<skip>false</skip>
									</signing>
									-->
								</configuration>
							</execution>
						</executions>
					</plugin>
				</plugins>
			</build>

Be able to use the "customize" and "require-scripts" options

Any way to use these options?

pkg/pkg-core/src/main/java/com/github/gino0631/pkg/ProductBuilder.java

Line 223 in e35bf63

new Options(Options.Customize.NEVER, false),

https://github.com/gino0631/pkg/blob/616d9ae68a1df5193e362d7ac15002ab6c752465/pkg-core/src/main/java/com/github/gino0631/pkg/jaxb/distribution/Options.java

Maybe something like that:

<installer-script>
	<options>
		<customize>allow</customize>
		<require-scripts>false</require-scripts>
	</options>
</installer-script>

or

<customize>allow</customize>
<require-scripts>false</require-scripts>

Missing transparency

Except if i missed something the textual windows transparency is not set so the background image is hidden.
Below is a sample with transparency: