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

go_package


A first-party Go package (corresponding to a directory with .go files).

Expects that there is a go_mod target in its directory or in an ancestor directory.

Backend: pants.backend.experimental.go


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.13/docs/targets#target-addresses and https://www.pantsbuild.org/v2.13/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.

sources

field.type_hint
default: ('*.go', '*.s')

A list of files and globs that belong to this target.

Paths are relative to the BUILD file's directory. You can ignore files/globs by prefixing them with !.

Example: sources=['example.go', '*_test.go', '!test_ignore.go']

test_extra_env_vars

field.type_hint
required

Additional environment variables to include in test processes. Entries are strings in the form ENV_VAR=value to use explicitly; or just ENV_VAR to copy the value of a variable in Pants's own environment. This will be merged with and override values from [test].extra_env_vars.

test_timeout

field.type_hint
required

A timeout (in seconds) when running this package's tests.

If this field is not set, the test will never time out.

skip_tests

field.type_hint
default: False

If true, don't run this package's tests.

skip_gofmt

field.type_hint
default: False
backend: pants.backend.experimental.go

If true, don't run gofmt on this package.