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
assembler_flags
Iterable[str] | NoneNoneExtra flags to pass to the Go assembler (i.e., go tool asm) when assembling Go-format assembly code.
Note: These flags will not be added to gcc/clang-format assembly that is assembled in packages using Cgo.
This field can be specified on several different target types:
-
On
go_modtargets, the assembler flags are used when building any package involving the module including both first-party (i.e.,go_packagetargets) and third-party dependencies. -
On
go_binarytargets, the assembler flags are used when building any packages comprising that binary including third-party dependencies. These assembler flags will be added after any assembler flags added by anyassembler_flagsfield set on the applicablego_modtarget. -
On
go_packagetargets, the assembler flags are used only for building that specific package and not for any other package. These assembler flags will be added after any assembler flags added by anyassembler_flagsfield set on the applicablego_modtarget or applicablego_binarytarget.
Run go doc cmd/asm to see the flags supported by go tool asm.
compiler_flags
Iterable[str] | NoneNoneExtra flags to pass to the Go compiler (i.e., go tool compile) when compiling Go code.
This field can be specified on several different target types:
-
On
go_modtargets, the compiler flags are used when compiling any package involving the module including both first-party (i.e.,go_packagetargets) and third-party dependencies. -
On
go_binarytargets, the compiler flags are used when compiling any packages comprising that binary including third-party dependencies. These compiler flags will be added after any compiler flags added by anycompiler_flagsfield set on the applicablego_modtarget. -
On
go_packagetargets, the compiler flags are used only for compiling that specific package and not for any other package. These compiler flags will be added after any compiler flags added by anycompiler_flagsfield set on the applicablego_modtarget or applicablego_binarytarget.
Run go doc cmd/compile to see the flags supported by go tool compile.
dependencies
Iterable[str] | NoneNoneAddresses 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.21/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 | NoneNoneA human-readable description of the target.
Use pants list --documented :: to see all targets with descriptions.
skip_go_vet
boolFalsepants.backend.experimental.go.lint.vetIf true, don't run go vet on this target's code.
skip_gofmt
boolFalsepants.backend.experimental.goIf true, don't run gofmt on this package.
skip_golangci_lint
boolFalsepants.backend.experimental.go.lint.golangci_lintIf true, don't run golangci-lint on this target's code.
skip_tests
boolFalseIf true, don't run this package's tests.
sources
Iterable[str] | None('*.go',)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
Iterable[str] | NoneNoneArbitrary 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_asan
bool | NoneNoneEnable interoperation between Go code and the C/C++ "address sanitizer" when building this package's test binary.
See https://github.com/google/sanitizers/wiki/AddressSanitizer for additional information about the C/C++ address sanitizer.
test_extra_env_vars
Iterable[str] | NoneNoneAdditional 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_msan
bool | NoneNoneEnable interoperation between Go code and the C/C++ "memory sanitizer" when building this package's test binary.
See https://github.com/google/sanitizers/wiki/MemorySanitizer for additional information about the C/C++ memory sanitizer.
test_race
bool | NoneNoneEnable compiling this package's test binary with the Go data race detector.
See https://go.dev/doc/articles/race_detector for additional information about the Go data race detector.
test_timeout
int | NoneNoneA timeout (in seconds) used by each test file belonging to this target.
If unset, will default to [test].timeout_default; if that option is also unset, then the test will never time out. Will never exceed [test].timeout_maximum. Only applies if the option --test-timeouts is set to true (the default).