go_first_party_package

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

You should not explicitly create this target in BUILD files. Instead, add a go_mod target where you have your go.mod file, which will generate go_first_party_package targets for you.

dependencies

type: Iterable[str] | None
default: None

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib'].

Alternatively, you may include file names. Pants will find which target owns that file, and create a new target from that which only includes the file in its sources field. For files relative to the current BUILD file, prefix with ./; otherwise, put the full path, e.g. ['./sibling.txt', 'resources/demo.json'].

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.

import_path

type: str
required

Import path in Go code to import this package.

This field should not be overridden; use the value from target generation.

skip_gofmt

type: bool
default: False

If true, don't run gofmt on this target's code.

sources

type: Iterable[str] | None
default: None

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.ext', 'test_*.ext', '!test_ignore.ext'].

subpath

type: str
required

The path from the owning go.mod to this package's directory, e.g. subdir.

This field should not be overridden; use the value from target generation.

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.


Did this page help you?