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

shell_library


Bourne-based shell scripts, e.g. Bash scripts.

Backend: ``


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 ./pants --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 ./pants 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'].

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.

sources

field.type_hint
default: ('*.sh', '!*_test.sh', '!test_*.sh', '!tests.sh')

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

skip_shellcheck

field.type_hint
default: False

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

skip_shfmt

field.type_hint
default: False

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