Skip to main content
Version: 2.12 (deprecated)

hadolint

A linter for Dockerfiles.

Backend: pants.backend.docker.lint.hadolint

Config section: [hadolint]

Basic options​

args​

--hadolint-args="[<shell_str>, <shell_str>, ...]"
PANTS_HADOLINT_ARGS
pants.toml
[hadolint]
args = [
    <shell_str>,
    <shell_str>,
    ...,
]
default: []

Arguments to pass directly to Hadolint, e.g. --hadolint-args='--format json'.

skip​

--[no-]hadolint-skip
PANTS_HADOLINT_SKIP
pants.toml
[hadolint]
skip = <bool>
default: False

Don't use Hadolint when running /home/josh/work/scie-pants/dist/pants lint.

Advanced options​

config​

--hadolint-config=<file_option>
PANTS_HADOLINT_CONFIG
pants.toml
[hadolint]
config = <file_option>
default: None

Path to an YAML config file understood by Hadolint (https://github.com/hadolint/hadolint#configure).

Setting this option will disable [hadolint].config_discovery. Use this option if the config is located in a non-standard location.

config_discovery​

--[no-]hadolint-config-discovery
PANTS_HADOLINT_CONFIG_DISCOVERY
pants.toml
[hadolint]
config_discovery = <bool>
default: True

If true, Pants will include all relevant config files during runs (.hadolint.yaml and .hadolint.yml).

Use [hadolint].config instead if your config is in a non-standard location.

known_versions​

--hadolint-known-versions="['<str>', '<str>', ...]"
PANTS_HADOLINT_KNOWN_VERSIONS
pants.toml
[hadolint]
known_versions = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "v2.8.0|macos_x86_64|27985f257a216ecab06a16e643e8cb0123e7145b5d526cfcb4ce7a31fe99f357|2428944",
  "v2.8.0|macos_arm64 |27985f257a216ecab06a16e643e8cb0123e7145b5d526cfcb4ce7a31fe99f357|2428944",
  "v2.8.0|linux_x86_64|9dfc155139a1e1e9b3b28f3de9907736b9dfe7cead1c3a0ae7ff0158f3191674|5895708"
]

Known versions to verify downloads against.

Each element is a pipe-separated string of version|platform|sha256|length, where:

- `version` is the version string
- `platform` is one of [linux_arm64,linux_x86_64,macos_arm64,macos_x86_64],
- `sha256` is the 64-character hex representation of the expected sha256
digest of the download file, as emitted by `shasum -a 256`
- `length` is the expected length of the download file in bytes, as emitted by
`wc -c`

E.g., 3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813.

Values are space-stripped, so pipes can be indented for readability if necessary.

url_platform_mapping​

--hadolint-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_HADOLINT_URL_PLATFORM_MAPPING
pants.toml
[hadolint.url_platform_mapping]
key1 = val1
key2 = val2
...
default: 
{
  "linux_x86_64": "Linux-x86_64",
  "macos_arm64": "Darwin-x86_64",
  "macos_x86_64": "Darwin-x86_64"
}

A dictionary mapping platforms to strings to be used when generating the URL to download the tool.

In --url-template, anytime the {platform} string is used, Pants will determine the current platform, and substitute {platform} with the respective value from your dictionary.

For example, if you define {"macos_x86_64": "apple-darwin", "linux_x86_64": "unknown-linux"}, and run Pants on Linux with an intel architecture, then {platform} will be substituted in the --url-template option with unknown-linux.

url_template​

--hadolint-url-template=<str>
PANTS_HADOLINT_URL_TEMPLATE
pants.toml
[hadolint]
url_template = <str>
default: https://github.com/hadolint/hadolint/releases/download/{version}/hadolint-{platform}

URL to download the tool, either as a single binary file or a compressed file (e.g. zip file). You can change this to point to your own hosted file, e.g. to work with proxies or for access via the filesystem through a file:$abspath URL (e.g. file:/this/is/absolute, possibly by templating the buildroot in a config file).

Use {version} to have the value from --version substituted, and {platform} to have a value from --url-platform-mapping substituted in, depending on the current platform. For example, https://github.com/.../protoc-&#123;version&#125;-&#123;platform&#125;.zip.

use_unsupported_version​

--hadolint-use-unsupported-version=<UnsupportedVersionUsage>
PANTS_HADOLINT_USE_UNSUPPORTED_VERSION
pants.toml
[hadolint]
use_unsupported_version = <UnsupportedVersionUsage>
one of: error, warning
default: error

What action to take in case the requested version of Hadolint is not supported.

Supported Hadolint versions: unspecified

version​

--hadolint-version=<str>
PANTS_HADOLINT_VERSION
pants.toml
[hadolint]
version = <str>
default: v2.8.0

Use this version of Hadolint.

Deprecated options​

None

None