Pants 2.13: Easier at the command line, easier parallel execution in CI, Kotlin support, and better Python and JVM support!
We're pleased to announce Pants 2.13.0. Highlights include better command line arguments for file sets, improved JVM support, easier access to parallel execution in CI, and lower barriers to adoption for Python projects that currently use existing distribution and build tools.
We're pleased to announce Pants 2.13.0, the latest release of Pants, the scalable and ergonomic build system. Highlights of this release include experimental support for Kotlin on the JVM, better command line arguments for file sets, improved JVM support, easier access to parallel execution in CI, and lower barriers to adoption for Python projects that currently use existing distribution and build tools.
You can update by setting
pants_version = "2.13.0" in your
pants.toml file. See upgrade tips for more information.
Making it easier to work with file sets at the command line
We've improved our command line arguments to make it easier to run Pants against multiple files, and making the behavior of different goals more consistent, so they're easier to learn and remember.
You can now
filter targets in a goal, which lets you select targets of a specific type from a broader set of targets. For example, it's now easy to run just the Python tests when running the
test goal over your entire codebase:
./pants filter --target-type=python_test :: | xargs ./pants test
./pants --filter-target-type=python_test test ::[#15599]
You can now easily run Pants against all targets in a directory by specifying a directory name at the command line. Previously, specifying a directory name was a shorthand for a specific target in a directory.
You can now selectively ignore targets, files, and directories when running a goal against a set of files. To ignore targets, add an extra argument, prefixed with a
-, for example, to run all of your Python tests, except the
integration_tests directory, you could run
./pants test src/py:: -src/py/integration_tests. [#15619]
Finally, you can now supply files to any Pants goal in the same way! Previously, some goals handled arguments in their own way, making it difficult to switch between goals, or use multiple goals for the same invocation. Now, the
:: glob, or the
--changed-since command line option works for any goal that needs a list of targets. For example, try
./pants count-loc :: to get the lines of code in your project (previously, you'd need to use
./pants --changed-since=HEAD update-build-files to only format changed
BUILD files [#15577], [#14434]
Easy parallel execution in CI with test sharding
One goal of Pants is to make it easier to speed up your build and CI suites. Up until now, Pants' support for speeding up builds with parallelism has been limited to remote execution services. Remote execution is highly flexible, at a cost of higher complexity.
For an easier first step into speeding up your test suite in CI, Pants 2.13 adds support for sharded test suites, which splits test execution across a configurable number of machines. Parallelism with sharding can give faster results than running on a single machine, while being easier to get started than a remote execution suite.
To enable, use the
PANTS_TEST_SHARD environment variable or
--test-shard command line option. Setting a value of
k/N will deterministically split your test suite into
N shards (by number of files only) and run the
kth subset of that shard. [#15417]
Experimental Kotlin on JVM Support
Fresh after adding support for Java and Scala, we've added initial support for Kotlin on the JVM, which brings all of the features from other JVM languages including multiple lockfile support for third-party dependencies, and JUnit for running your tests, along with integration with popular Kotlin tools including KtLint.
Kotlin support is still work-in-progress, but we'd love for you to try it out and let us know how we can improve it.
Improved fine-tuning in JVM builds with per-tool options
Following on from our initial experimental JVM support first released last year, Pants 2.13 now allows you to provide per-tool configuration for the underlying steps in your build. This is particularly handy for adjusting memory allocations for more heavyweight compilers without increasing the memory for tools that don't need it.
The end result is that you should be able to run more JVM build steps in parallel on the same machine.
To enable, you can set the
jvm_options setting in the relevant tool's configuration block in your
pants.toml file. See, for example, our JUnit support documentation. [#15505]
Improved IDE support for JVM languages
Our Build Server Protocol-based IDE support has gained a few more features since the initial release in Pants 2.12. We now support automatic JDK configuration for Scala projects, and it's now possible for IntelliJ to run tests against class files that have been built by Pants [#15408], [#15347].
More efficient remote cache access
We've added new behaviors to our remote cache support which can improve the efficiency and performance by optionally skipping downloads of cache entries where possible.
With the new
[GLOBAL].cache_content_behavior = "validate" flag, Pants will register a cache hit after validating that the contents exist, rather than first requiring a successful download. Depending on the shape of their code, users have seen anywhere from 25% to 75% fewer bytes downloaded in CI runs with
"validate" set. Please try it out and let us know what you think!
Because this can change the behavior of builds when a remote cache is flaky or unavailable,
"validate" mode remains optional behavior, with the old-style
"fetch" behavior remaining the default. [#16409]
Lower barriers to adoption for Python open source projects
We're also working towards making it easier to adopt pants in Python projects that use the setuptools or distutils workflows. This release adds support for
Pants 2.13 adds support for the
setuptools_scm tools, which allow Python projects to use git tags and commit hashes to set the project version in built packages. Files generated by
setuptools_scm are fully supported by existing Pants features`, including dependency inference [#15374], [#15385].
We've also started building out initial support for Python build-time requirements, starting with producing dists that use
mypyc in their existing
setup.py file [#15380].
Other notable changes
As always, this release brings a whole pile of smaller features, improvements, and bugfixes, including:
./pants runsupport for visual debuggers in Python [#15799]
./pants runsupport for arbitrary Python targets [#16022]
tailorimprovements including support for
Adding file downloading support to asset targets [#15457]
Support for Kotlin JUnit tests [#15382]
Added the option
lint --skip-formattersto avoid running formatters like Black and Scalafmt in check-only mode. [#15427]
Improved error messages for invalid target addresses. [#15751]
See the full changelog for more changes, along with our plugin upgrade guide.
Try out one of our example repositories:
And let us know what you think in Slack!
Pants wouldn't be possible without everyone who contributed to 2.13, including everyone who shared feedback on changes and who tested release candidates! Thank you all!