PackagingOptions

DSL object for configuring APK packaging options.

Packaging options are configured with three sets of paths: first-picks, merges and excludes:

To decide the action on a specific path, the following algorithm is used:

Patterns in packaging options are specified as globs following the syntax in the Java Filesystem API. All paths should be configured using forward slashes (/).

All paths to be matched are provided as absolute paths from the root of the apk archive. So, for example, classes.dex is matched as /classes.dex. This allows defining patterns such as **/foo to match the file foo in any directory, including the root. Any pattern that does not start with a forward slash (or wildcard) is automatically prepended with a forward slash. So, file and /file are effectively the same pattern.

Several paths are excluded by default:

Example that adds the first anyFileWillDo file found and ignores all the others and that excludes anything inside a secret-data directory that exists in the root:

packagingOptions {
    pickFirst anyFileWillDo
    exclude /secret-data/**
}

Example that removes all patterns:

packagingOptions {
    pickFirsts = [] // Not really needed because the default is empty.
    merges = []     // Not really needed because the default is empty.
    excludes = []
}

Example that merges all LICENCE.txt files in the root.

packagingOptions {
    merges = "/LICENCE.txt"
    excludes -= ["/LICENCE.txt"] // Not needed because merges take precedence over excludes
}