Skip to main content
Version: 2.12.x (deprecated)

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.java

tags​

field.type_hint
required

Arbitrary strings to describe a target.

For example, you may tag some test targets with 'integration_test' so that you could run /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 --tag='integration_test' test :: to only run on targets with that tag.

description​

field.type_hint
required

A human-readable description of the target.

Use /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 list --documented :: to see all targets with descriptions.

dependencies​

field.type_hint
required

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 /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 dependencies or /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 peek on this target to get the final result.

See https://www.pantsbuild.org/v2.12/docs/targets#target-addresses and https://www.pantsbuild.org/v2.12/docs/targets#target-generation for more about how addresses are formed, including for generated targets. You can also run /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 list :: to find all addresses in your project, or /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 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.

output_path​

field.type_hint
required

Where the built asset should be located.

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.

When running /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 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.

main​

field.type_hint
required

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

jdk​

field.type_hint
required

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

resolve​

field.type_hint
required

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

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

restartable​

field.type_hint
default: False

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