pants.ini

# All of the following are seeded with defaults in the config
#   user: the current user
#   homedir: the current user's home directory
#   buildroot: the root of this repo
#   pants_bootstrapdir: the global pants scratch space primarily used for caches
#   pants_configdir: the global pants storage for config files
#   pants_supportdir: pants support files for this repo go here; for example: ivysettings.xml
#   pants_distdir: user visible artifacts for this repo go here
#   pants_workdir: the scratch space used to for live builds in this repo


# [DEFAULT] should only contain variables to be used later in this config or
# options not in global scope but available in certain subsystems or tasks.
[DEFAULT]
# TODO: Still needed until we migrate jvm tools to subsystems.
jvm_options: ["-Xmx1g"]

local_artifact_cache: %(pants_bootstrapdir)s/artifact_cache


# [GLOBAL] should only contain valid options in global scope.
[GLOBAL]
print_exception_stacktrace: True

# Enable our own custom loose-source plugins as well as contribs.
pythonpath: [
    "%(buildroot)s/contrib/avro/src/python",
    "%(buildroot)s/contrib/awslambda/python/src/python",
    "%(buildroot)s/contrib/buildrefactor/src/python",
    "%(buildroot)s/contrib/codeanalysis/src/python",
    "%(buildroot)s/contrib/cpp/src/python",
    "%(buildroot)s/contrib/confluence/src/python",
    "%(buildroot)s/contrib/errorprone/src/python",
    "%(buildroot)s/contrib/findbugs/src/python",
    "%(buildroot)s/contrib/go/src/python",
    "%(buildroot)s/contrib/googlejavaformat/src/python",
    "%(buildroot)s/contrib/jax_ws/src/python",
    "%(buildroot)s/contrib/mypy/src/python",
    "%(buildroot)s/contrib/node/src/python",
    "%(buildroot)s/contrib/python/src/python",
    "%(buildroot)s/contrib/scalajs/src/python",
    "%(buildroot)s/contrib/scrooge/src/python",
    "%(buildroot)s/contrib/thrifty/src/python",
    "%(buildroot)s/pants-plugins/src/python",
  ]

backend_packages: +[
    "pants.backend.docgen",
    "internal_backend.rules_for_testing",
    "internal_backend.repositories",
    "internal_backend.sitegen",
    "internal_backend.utilities",
    "pants.contrib.avro",
    "pants.contrib.awslambda.python",
    "pants.contrib.buildrefactor",
    "pants.contrib.codeanalysis",
    "pants.contrib.cpp",
    "pants.contrib.confluence",
    "pants.contrib.errorprone",
    "pants.contrib.findbugs",
    "pants.contrib.go",
    "pants.contrib.googlejavaformat",
    "pants.contrib.jax_ws",
    "pants.contrib.scalajs",
    "pants.contrib.mypy",
    "pants.contrib.node",
    "pants.contrib.python.checks",
    "pants.contrib.scrooge",
    "pants.contrib.thrifty",
  ]

# Path patterns to ignore for filesystem operations on top of the builtin patterns.
pants_ignore: +[
    # venv directories under build-support.
    '/build-support/*.venv/',

    # An absolute symlink to the Pants Rust toolchain sources.
    '/build-support/bin/native/src',
  ]


[cache]
# Caching is on globally by default, but we disable it here for development purposes.
# It is explicitly re-enabled below for [cache.bootstrap] only.
read_from: []
write_to: []


[cache.bootstrap]
# The just-in-time tool shading performed by jvm tool bootstrapping is very expensive, so we turn
# on artifact caching for it that can survive clean-all.
read_from: ["%(local_artifact_cache)s"]
write_to: ["%(local_artifact_cache)s"]


[ivy]
# A custom ivysettings.xml file to allow for consumption from a local .m2 repository.
# If you don't need access to a local .m2 repository, remove this setting to use the default.
ivy_settings: %(pants_supportdir)s/ivy/ivysettings.xml
# We need a custom ivy profile to grab the optional pgp libs for
# signing artifacts we publish to maven central.
ivy_profile: %(pants_supportdir)s/ivy/ivy.xml


[gen.scrooge]
service_deps: {
    'java': [
      '3rdparty:slf4j-api',
      '3rdparty:thrift',
      '3rdparty/jvm/com/twitter:finagle-thrift',
      '3rdparty/jvm/com/twitter:scrooge-core',
    ],
    'scala': [
      '3rdparty:thrift',
      '3rdparty/jvm/com/twitter:finagle-thrift',
      '3rdparty/jvm/com/twitter:scrooge-core',
    ],
  }
structs_deps: {
    'java': [
      '3rdparty:thrift',
      '3rdparty/jvm/com/twitter:scrooge-core',
    ],
    'scala': [
      '3rdparty:thrift',
      '3rdparty/jvm/com/twitter:scrooge-core',
    ],
  }
service_exports: {
    'java': [
      '3rdparty:thrift',
    ],
    'scala': [
      '3rdparty:thrift',
      '3rdparty/jvm/com/twitter:finagle-thrift',
      '3rdparty/jvm/com/twitter:scrooge-core',
    ],
  }
structs_exports: {
    'java': [
      '3rdparty:thrift',
    ],
    'scala': [
      '3rdparty:thrift',
      '3rdparty/jvm/com/twitter:scrooge-core',
    ],
  }


[gen.thrift-java]
deps: ["3rdparty:thrift"]


[gen.thrift-py]
deps: ["examples/3rdparty/python:thrift"]


[gen.py-thrift-namespace-clash-check]
strict: True


[gen.thrifty]
allow_dups: True


[gen.antlr-py]
antlr3_deps: ["3rdparty/python:antlr-3.1.3"]


[gen.go-protobuf]
import_target: contrib/go/examples/src/protobuf/org/pantsbuild/example:protobuf-deps


[compile.errorprone]
command_line_options: [
    # See http://errorprone.info/bugpatterns for all patterns
    '-Xep:CatchAndPrintStackTrace:OFF',
    '-Xep:StringSplitter:OFF',
  ]
exclude_patterns: [
    'contrib/errorprone/tests/java/org/pantsbuild/contrib/errorprone:error',
    'testprojects/src/java/org/pantsbuild/testproject/.*'
  ]

[compile.findbugs]
max_rank: 4
fail_on_error: True
exclude_patterns: [
    'contrib/findbugs/tests/java/org/pantsbuild/contrib/findbugs:high',
    'testprojects/src/java/org/pantsbuild/testproject/.*'
  ]

[compile.zinc]
jvm_options: [
    '-Xmx4g', '-XX:+UseConcMarkSweepGC', '-XX:ParallelGCThreads=4',
  ]

args: [
    # NB: See https://github.com/pantsbuild/pants/issues/3702
    '-C-encoding', '-CUTF-8',
    '-S-encoding', '-SUTF-8',
    '-S-g:vars',
    # Compiling the zinc codebase with `2.11.12` requires that scala target `JDK8`:
    # this setting is a function of the fact that the libraries we're consuming require it,
    # rather than anything inherent to `2.11.12`.
    '-S-target:jvm-1.8',
  ]
warning_args: [
    '-S-deprecation',
    '-S-unchecked',
    # request warnings for http://www.scala-lang.org/api/2.10.4/index.html#scala.language$
    '-S-feature',
  ]
no_warning_args: [
    '-S-nowarn',
  ]

[compile.javac]
args: [
    '-encoding', 'UTF-8',
    '-J-Xmx2g',
  ]

# javac -help -X will show the complete list
warning_args: [
    '-Xlint:deprecation',
    '-Xlint:empty',
    '-Xlint:finally',
    '-Xlint:overrides',
    '-Xlint:static',
    '-Xlint:unchecked',
    '-Xlint:try',
  ]
no_warning_args: [
    '-Xlint:none',
  ]

[node-distribution]
eslint_setupdir: %(pants_supportdir)s/eslint
eslint_config: %(pants_supportdir)s/eslint/.eslintrc
eslint_ignore: %(pants_supportdir)s/eslint/.eslintignore

[lint.checkstyle]
configuration: %(pants_supportdir)s/checkstyle/coding_style.xml

[lint.google-java-format]
skip: True

[lint.python-eval]
# After we fix the cycles from the engine refactor we should re-enable this.
# https://github.com/pantsbuild/pants/issues/4601
skip: True
# We must set this explicitly, even though it's the default, until the old
# --closure option is removed. See comment in the task code for details.
transitive: True

[lint.scalafmt]
skip: True

[lint.scalafix]
skip: True

[lint.scalastyle]
config: %(buildroot)s/build-support/scalastyle/scalastyle_config.xml
excludes: %(buildroot)s/build-support/scalastyle/excludes.txt

[fmt.google-java-format]
skip: True

[fmt.scalafmt]
skip: True

[fmt.scalafix]
skip: True

[protoc.gen.go-protobuf]
version=3.4.1

[pycheck-class-factoring]
skip: True

[pycheck-pycodestyle]
skip: True

[pycheck-import-order]
skip: True

[pycheck-variable-names]
skip: True

[pycheck-trailing-whitespace]
skip: True

[pycheck-context-manager]
skip: True

[scala]
version: 2.12


[java]
strict_deps: True

[jvm]
options: ["-Xmx1g"]

[jvm.bench]
options: ["-Xmx1g"]

[jvm.run.jvm]
options: ["-Xmx1g"]

[jvm.test.junit]
options: [
    "-Djava.awt.headless=true", "-Xmx1g",
  ]

# NB(gmalmquist): You can set the bootclasspath relative to the
# appropriate java home (inferred from the target level) by setting
# an arg like:
# "-C-Xbootclasspath:$JAVA_HOME/jre/lib/resources.jar:$JAVA_HOME/jre/lib/rt.jar:$JAVA_HOME/jre/lib/sunrsasign.jar:$JAVA_HOME/jre/lib/jsse.jar:$JAVA_HOME/jre/lib/jce.jar:$JAVA_HOME/jre/lib/charsets.jar:$JAVA_HOME/jre/lib/jfr.jar:$JAVA_HOME/jre/classes"
[jvm-platform]
default_platform: java8
platforms: {
    'java6': {'source': '6', 'target': '6', 'args': [] },
    'java7': {'source': '7', 'target': '7', 'args': [] },
    'java8': {'source': '8', 'target': '8', 'args': [] },
  }


[pants-releases]
branch_notes: {
    'master': 'src/python/pants/notes/master.rst',
    '1.0.x': 'src/python/pants/notes/1.0.x.rst',
    '1.1.x': 'src/python/pants/notes/1.1.x.rst',
    '1.2.x': 'src/python/pants/notes/1.2.x.rst',
    '1.3.x': 'src/python/pants/notes/1.3.x.rst',
    '1.4.x': 'src/python/pants/notes/1.4.x.rst',
    '1.5.x': 'src/python/pants/notes/1.5.x.rst',
    '1.6.x': 'src/python/pants/notes/1.6.x.rst',
    '1.7.x': 'src/python/pants/notes/1.7.x.rst',
    '1.8.x': 'src/python/pants/notes/1.8.x.rst',
    '1.9.x': 'src/python/pants/notes/1.9.x.rst',
    '1.10.x': 'src/python/pants/notes/1.10.x.rst',
    '1.11.x': 'src/python/pants/notes/1.11.x.rst',
    '1.12.x': 'src/python/pants/notes/1.12.x.rst',
    '1.13.x': 'src/python/pants/notes/1.13.x.rst',
    '1.14.x': 'src/python/pants/notes/1.14.x.rst',
    '1.15.x': 'src/python/pants/notes/1.15.x.rst',
  }


[publish.jar]
ivy_settings: %(pants_supportdir)s/ivy/publish.ivysettings.xml
push_postscript:
  # Prevent Travis-CI from running for this automated jar publish commit:
  #   http://docs.travis-ci.com/user/how-to-skip-a-build/
  [ci skip]
repos: {
    'public': {  # must match the name of the `Repository` object that you defined in your plugin.
      'resolver': 'oss.sonatype.org', # must match hostname in ~/.netrc and the <url> parameter
                                      # in your custom ivysettings.xml.
      'auth': 'build-support/ivy:netrc',  # Pants spec to a 'credentials()' object.
      'help': 'Configure your ~/.netrc for oss.sonatype.org access.'
    }
  }
restrict_push_branches: ['master']
restrict_push_urls: [
    'git@github.com:pantsbuild/pants.git',
    'https://github.com/pantsbuild/pants.git'
  ]
# The commithooks on this repository cause a deadlock while acquiring the workspace lock
# if a commit is made from within pants: skip them.
verify_commit: False


[python-setup]
# We will support Python 2 until release 1.16, at which we will drop Python 2 support and
# require Python 3.6+ to run Pants.
# Note this does not mean client code has to use these specified versions, only that
# an appropriate interpreter must be discoverable.
interpreter_constraints: ["CPython>=2.7,<3","CPython>=3.6,<4"]
interpreter_cache_dir: %(pants_bootstrapdir)s/python_cache/interpreters
resolver_cache_dir: %(pants_bootstrapdir)s/python_cache/requirements


[test.pytest]
timeouts: true
timeout_default: 60


[test.junit]
chroot: true
timeouts: true
timeout_default: 60


[buildgen.go]
materialize: True
remote: True
fail_floating: True


# Site generation options.
[reference]
pants_reference_template: reference/pants_reference_body.html
build_dictionary_template: reference/build_dictionary_body.html

[markdown]
fragment: True

[sitegen]
config_path: src/docs/docsite.json

# TODO(#6848, #7122): A gcc toolchain is currently required to build the tensorflow_custom_op example. This
# should be removed when we can fully support both toolchains, and select between them with constraints.
[native-build-step]
toolchain_variant: gnu

[native-build-step.cpp-compile-settings]
# TensorFlow 1.13 on python 3.7 specifically uses a newer C++ ABI than any other TensorFlow release,
# so in this repo's CI we override this option to avoid using the previous ABI for our python 3.7
# testing by setting PANTS_NATIVE_BUILD_STEP_CPP_COMPILE_SETTINGS_DEFAULT_COMPILER_OPTION_SETS="[]"
# in the environment.
default_compiler_option_sets: ['glibcxx_use_old_abi']
compiler_option_sets_enabled_args: {
    # TensorFlow custom operators cannot be built against the C++11 ABI yet: see
    # https://www.tensorflow.org/guide/extend/op.
    'glibcxx_use_old_abi': ['-D_GLIBCXX_USE_CXX11_ABI=0'],
  }
compiler_option_sets_disabled_args: {
    'glibcxx_use_old_abi': ['-D_GLIBCXX_USE_CXX11_ABI=1'],
  }

[libc]
enable_libc_search: True

[sourcefile-validation]
config: @build-support/regexes/config.yaml