coremedia-application:zip-it

Full name:

com.coremedia.maven:coremedia-application-maven-plugin:3.0.1:zip-it

Description:

Zips the result of the package-inplace goal and attaches the zip file as project artifact. There are two modes:
  • Deployable Application (default)
  • Skinny Application

The deployable application corresponds to the generated artifact in the ${project.build.directory}/${project.build.finalName}/ folder. If a skinny application is chosen all referenced jar artifacts are not included in the packaged artifact e.g. no lib/*.jar and also no ${project.build.directory}/${project.build.finalName}/config/[applicationName]/framework/*.jar.

If war artifacts are merged in, their jars won't be excluded from the zipped artifact since they are loaded by an isolated classloader and therefore no dependencyManagement can be applied on further aggregation layers.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
<classifier> String 2.4 The classifier used for installing or deploying the created artifact
<executables> String[] 2.7 Lists all files that need the executable flag. All files listed here will be executable in the FS and in the ZIP. Default is 
<executables>
 <executable>bin/cm</executable>
 <executable>bin/*.sh</executable>
 <executable>bin/bshrc</executable>
 <executable>bin/bshrc-scripting</executable>
 <executable>bin/bsh</executable>
</executables>

<libDir> String 2.4 The directory path relative to the configured outputDirectory, where jars have been retrieved to.
Default value is: lib.
<outputDirectory> File 2.0 Location of the assembled application.

Default value is: ${project.build.directory}/${project.build.finalName}.
<outputFile> File - The path of the archive to be created. The default value will be ${project.build.directory}/${project.build.finalName}.zip
<outputTimestamp> String 3.0.0 Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
Default value is: ${project.build.outputTimestamp}.
<skinnyApplication> boolean - Tells the archiver to exclude the jars from the final ZIP. This is equal to having an exclude in the zipConfig element.
Default value is: false.
<skipArchiving> boolean 2.4 Skips the archive creation.
Default value is: false.
<skipZipArchiving> boolean 2.7 Skips the archive creation.
Default value is: false.
User property is: skipZipArchiving.
<zipConfig> ZipConfig 2.4 The configuration for the zip mojo 
  <zipConfig>
   <includes>**/*</includes>
   <excludes>private/**</excludes>
   <prefix>SOME_PREFIX</excludes>
  </zipConfig>

Parameter Details

<classifier>

The classifier used for installing or deploying the created artifact
  • Type: java.lang.String
  • Since: 2.4
  • Required: No

<executables>

Lists all files that need the executable flag. All files listed here will be executable in the FS and in the ZIP. Default is 
<executables>
 <executable>bin/cm</executable>
 <executable>bin/*.sh</executable>
 <executable>bin/bshrc</executable>
 <executable>bin/bshrc-scripting</executable>
 <executable>bin/bsh</executable>
</executables>
  • Type: java.lang.String[]
  • Since: 2.7
  • Required: No

<libDir>

The directory path relative to the configured outputDirectory, where jars have been retrieved to.
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • Default: lib

<outputDirectory>

Location of the assembled application.
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • Default: ${project.build.directory}/${project.build.finalName}

<outputFile>

The path of the archive to be created. The default value will be ${project.build.directory}/${project.build.finalName}.zip
  • Type: java.io.File
  • Required: No

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
  • Type: java.lang.String
  • Since: 3.0.0
  • Required: No
  • Default: ${project.build.outputTimestamp}

<skinnyApplication>

Tells the archiver to exclude the jars from the final ZIP. This is equal to having an exclude in the zipConfig element.
  • Type: boolean
  • Required: No
  • Default: false

<skipArchiving>

Skips the archive creation.
  • Type: boolean
  • Since: 2.4
  • Required: No
  • Default: false

<skipZipArchiving>

Skips the archive creation.
  • Type: boolean
  • Since: 2.7
  • Required: No
  • User Property: skipZipArchiving
  • Default: false

<zipConfig>

The configuration for the zip mojo 
  <zipConfig>
   <includes>**/*</includes>
   <excludes>private/**</excludes>
   <prefix>SOME_PREFIX</excludes>
  </zipConfig>
  • Type: com.coremedia.cms.maven.application.zip.ZipConfig
  • Since: 2.4
  • Required: No