A linter for Dockerfiles.

Backend: pants.backend.docker.lint.hadolint
Config section: [hadolint]

Basic options

skip

--[no-]hadolint-skip

PANTS_HADOLINT_SKIP

default: False

Don't use Hadolint when running ./pants lint.


args

--hadolint-args="[<shell_str>, <shell_str>, ...]"

PANTS_HADOLINT_ARGS

default: []

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


Advanced options

version

--hadolint-version=<str>

PANTS_HADOLINT_VERSION

default: v2.10.0

Use this version of Hadolint.


known_versions

--hadolint-known-versions="['<str>', '<str>', ...]"

PANTS_HADOLINT_KNOWN_VERSIONS

default:
[
  "v2.10.0|macos_x86_64|59f0523069a857ae918b8ac0774230013f7bcc00c1ea28119c2311353120867a|2514960",
  "v2.10.0|macos_arm64 |59f0523069a857ae918b8ac0774230013f7bcc00c1ea28119c2311353120867a|2514960",
  "v2.10.0|linux_x86_64|8ee6ff537341681f9e91bae2d5da451b15c575691e33980893732d866d3cefc4|2301804",
  "v2.10.0|linux_arm64 |b53d5ab10707a585c9e72375d51b7357522300b5329cfa3f91e482687176e128|27954520"
]

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.


use_unsupported_version

--hadolint-use-unsupported-version=<UnsupportedVersionUsage>

PANTS_HADOLINT_USE_UNSUPPORTED_VERSION

one of: error, warning
default: error

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

Supported Hadolint versions: unspecified


url_template

--hadolint-url-template=<str>

PANTS_HADOLINT_URL_TEMPLATE

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-{version}-{platform}.zip.


url_platform_mapping

--hadolint-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"

PANTS_HADOLINT_URL_PLATFORM_MAPPING

default:
{
  "linux_arm64": "Linux-arm64",
  "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.


config

--hadolint-config=<file_option>

PANTS_HADOLINT_CONFIG

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

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.


Deprecated options

None


Did this page help you?