HomeDocs
DocsCommunityTestimonialsUsersGitHubTwitterBlogJobsTermsPrivacyCookies
TermsPrivacyCookies
Hey! These docs are for version 2.14, which is no longer officially supported. Click here for the latest version, 2.17!


A linter for Dockerfiles.

Backend: <span style="color: purple"><code>pants.backend.docker.lint.hadolint</code></span> Config section: <span style="color: purple"><code>[hadolint]</code></span>

## Basic options

<div style="color: purple">

### `skip`

<code>--[no-]hadolint-skip</code><br> <code>PANTS_HADOLINT_SKIP</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>False</code></span>

<br>

If true, don't use Hadolint when running `./pants lint`.

</div> <br>

<div style="color: purple">

### `args`

<code>--hadolint-args="[&lt;shell_str&gt;, &lt;shell_str&gt;, ...]"</code><br> <code>PANTS_HADOLINT_ARGS</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>[]</code></span>

<br>

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

</div> <br>

## Advanced options

<div style="color: purple">

### `version`

<code>--hadolint-version=<str></code><br> <code>PANTS_HADOLINT_VERSION</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>v2.10.0</code></span>

<br>

Use this version of Hadolint.

</div> <br>

<div style="color: purple">

### `known_versions`

<code>--hadolint-known-versions="['&lt;str&gt;', '&lt;str&gt;', ...]"</code><br> <code>PANTS_HADOLINT_KNOWN_VERSIONS</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>[ "v2.10.0|macos&lowbar;x86&lowbar;64|59f0523069a857ae918b8ac0774230013f7bcc00c1ea28119c2311353120867a|2514960", "v2.10.0|macos&lowbar;arm64 |59f0523069a857ae918b8ac0774230013f7bcc00c1ea28119c2311353120867a|2514960", "v2.10.0|linux&lowbar;x86&lowbar;64|8ee6ff537341681f9e91bae2d5da451b15c575691e33980893732d866d3cefc4|2301804", "v2.10.0|linux&lowbar;arm64 |b53d5ab10707a585c9e72375d51b7357522300b5329cfa3f91e482687176e128|27954520" ]</pre></span>

<br>

Known versions to verify downloads against.

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



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

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

</div> <br>

<div style="color: purple">

### `use_unsupported_version`

<code>--hadolint-use-unsupported-version=<UnsupportedVersionUsage></code><br> <code>PANTS_HADOLINT_USE_UNSUPPORTED_VERSION</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">one of: <code>error, warning</code></span><br> <span style="color: green">default: <code>error</code></span>

<br>

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

Supported Hadolint versions: unspecified

</div> <br>

<div style="color: purple">

### `url_template`

<code>--hadolint-url-template=<str></code><br> <code>PANTS_HADOLINT_URL_TEMPLATE</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>https://github.com/hadolint/hadolint/releases/download/{version}/hadolint-{platform}</code></span>

<br>

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.

</div> <br>

<div style="color: purple">

### `url_platform_mapping`

<code>--hadolint-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"</code><br> <code>PANTS_HADOLINT_URL_PLATFORM_MAPPING</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>{ "linux&lowbar;arm64": "Linux-arm64", "linux&lowbar;x86&lowbar;64": "Linux-x86&lowbar;64", "macos&lowbar;arm64": "Darwin-x86&lowbar;64", "macos&lowbar;x86&lowbar;64": "Darwin-x86&lowbar;64" }</pre></span>

<br>

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.

</div> <br>

<div style="color: purple">

### `config`

<code>--hadolint-config=<file_option></code><br> <code>PANTS_HADOLINT_CONFIG</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>None</code></span>

<br>

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.

</div> <br>

<div style="color: purple">

### `config_discovery`

<code>--[no-]hadolint-config-discovery</code><br> <code>PANTS_HADOLINT_CONFIG_DISCOVERY</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>True</code></span>

<br>

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.

</div> <br>

## Deprecated options

None