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

dependencies

type: 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 Targets and BUILD files and 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

type: str | None
default: None

A human-readable description of the target.

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

skip_gofmt

type: bool
default: False
backend: pants.backend.experimental.go

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

skip_tests

type: bool
default: False

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

sources

type: Iterable[str] | None
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']

tags

type: 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.

test_extra_env_vars

type: Iterable[str] | None
default: None

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

type: int | None
default: None

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

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


Did this page help you?