example-docker
An example repository to demonstrate Pantsbuild's experimental Docker support.
See pantsbuild.org for much more detailed documentation.
This is only one possible way of laying out your project with Pantsbuild. See pantsbuild.org/docs/source-roots#examples for some other example layouts.
Note: Pantsbuild and Pants will be used interchangebly, they refer to the same thing, the Pants Build System.
Running Pantsbuild
You run Pants goals using the ./pants wrapper script, which will bootstrap the configured version
of Pants if necessary.
Use ./pants --version to see the version of Pants configured for the repo (which you can also find
in pants.toml).
Goals
Pants commands are called goals. You can get a list of goals with
./pants help goals
Most goals take arguments to run on. To run on a single directory, use the directory name with :
at the end. To recursively run on a directory and all its subdirectories, add :: to the end.
For example:
./pants lint src/python/hello_world: src/docker::
You can run on all changed files:
./pants --changed-since=HEAD lint
You can run on all changed files, and any of their "dependees":
./pants --changed-since=HEAD --changed-dependees=transitive test
Example Goals
Try these out in this repo!
Run a Docker image
./pants run src/docker/hello_world:python
./pants run src/docker/hello_world:shell
List targets
./pants list :: # All targets.
./pants list 'src/**/*.py' # Just targets containing Python code.
Run linters and formatters
./pants fmt lint :: # First format, then lint all sources.
Count lines of code
./pants count-loc '**/*'