Skip to main content
Version: 2.24 (prerelease)

deploy_jar

A jar file with first and third-party code bundled for deploys.

The JAR will contain class files for both first-party code and third-party dependencies, all in a common directory structure.

Backend: pants.backend.experimental.scala

main​

str
required

.-separated name of the JVM class containing the main() method to be called when executing this JAR.

dependencies​

Iterable[str] | None
default: None

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib', 'helloworld/main.py:lib', '3rdparty:reqs#django'].

This augments any dependencies inferred by Pants, such as by analyzing your imports. Use pants dependencies or pants peek on this target to get the final result.

See https://www.pantsbuild.org/2.24/docs/using-pants/key-concepts/targets-and-build-files for more about how addresses are formed, including for generated targets. You can also run pants list :: to find all addresses in your project, or pants list dir to find all addresses defined in that directory.

If the target is in the same BUILD file, you can leave off the BUILD file path, e.g. :tgt instead of helloworld/subdir:tgt. For generated first-party addresses, use ./ for the file path, e.g. ./main.py:tgt; for all other generated targets, use :tgt#generated_name.

You may exclude dependencies by prefixing with !, e.g. ['!helloworld/subdir:lib', '!./sibling.txt']. Ignores are intended for false positives with dependency inference; otherwise, simply leave off the dependency from the BUILD file.

description​

str | None
default: None

A human-readable description of the target.

Use pants list --documented :: to see all targets with descriptions.

duplicate_policy​

Iterable[pants.jvm.target_types.DeployJarDuplicateRule] | None
default: (duplicate_rule(pattern='^META-INF/services/', action='concat_text'), duplicate_rule(pattern='^META-INF/LICENSE', action='skip'))

A list of the rules to apply when duplicate file entries are found in the final assembled JAR file.

When defining a duplicate policy, just add duplicate_rule directives to this field as follows:

Example:

duplicate_policy=[
    duplicate_rule(pattern="^META-INF/services", action="concat_text"),
    duplicate_rule(pattern="^reference\.conf", action="concat_text"),
    duplicate_rule(pattern="^org/apache/commons", action="throw"),
]

Where:

  • The pattern field is treated as a regular expression
  • The action field must be one of ['skip', 'replace', 'concat', 'concat_text', 'throw'].

Note that the order in which the rules are listed is relevant.

exclude_files​

Iterable[str] | None
default: None

A list of patterns to exclude from the final jar.

jdk​

str | None
default: None

The major version of the JDK that this target should be built with. If not defined, will default to [jvm].default_source_jdk.

output_path​

str | None
default: '${spec_path_normalized}/${target_name_normalized}${file_suffix}'

Where the built asset should be located.

This field supports the following template replacements:

  • ${spec_path_normalized}: The path to the target's directory ("spec path") with forward slashes replaced by dots.

  • ${target_name_normalized}: The target's name with paramaterizations escaped by replacing dots with underscores.

  • ${file_suffix}: For target's which produce single file artifacts, this is the file type suffix to use with a leading dot, and is empty otherwise when not applicable.

If undefined, this will use the path to the BUILD file, followed by the target name. For example, src/python/project:app would be src.python.project/app.ext. This behavior corresponds to the default template: ${spec_path_normalized}/${target_name_normalized}${file_suffix}

When running pants package, this path will be prefixed by --distdir (e.g. dist/).

Warning: setting this value risks naming collisions with other package targets you may have.

resolve​

str | None
default: None

The resolve from [jvm].resolves to use when compiling this target.

If not defined, will default to [jvm].default_resolve.

restartable​

bool
default: False

If true, runs of this target with the run goal may be interrupted and restarted when its input files change.

shading_rules​

Iterable[pants.jvm.target_types.JvmShadingRule] | None
default: None

Shading rules to be applied to the final JAR artifact.

There are 4 possible shading rules available, which are as follows:

  • shading_relocate: Relocates the classes under the given package into the new package name. The default target package is __shaded_by_pants__ if none provided in the into parameter.
  • shading_rename: Renames all occurrences of the given pattern by the replacement.
  • shading_zap: Removes from the final artifact the occurrences of the pattern.
  • shading_keep: Keeps in the final artifact the occurrences of the pattern (and removes anything else).

When defining shading rules, just add them in this field using the previously listed rule alias and passing along the required parameters.

tags​

Iterable[str] | None
default: None

Arbitrary strings to describe a target.

For example, you may tag some test targets with 'integration_test' so that you could run pants --tag='integration_test' test :: to only run on targets with that tag.