Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
check

GitHub Action

Hadolint Github Action

v1.5.1

Hadolint Github Action

check

Hadolint Github Action

A stable, well-tested, highly configurable way of checking your Dockerfile(s) with Hadolint

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Hadolint Github Action

              
  uses: jbergstroem/hadolint-gh-action@v1.5.1
Learn more about this action in jbergstroem/hadolint-gh-action

Choose a version

Hadolint-action

A github action that checks your Dockerfile with hadolint. It supports a variety of options as well as annotating your Dockerfile with said results.

Usage

jobs:
  hadolint:
    runs-on: ubuntu-20.04
    name: "Hadolint"
    steps:
      - uses: actions/checkout@v2
      - uses: jbergstroem/hadolint-gh-action@v1

Parameters

Variable Default Description
dockerfile ./Dockerfile Path to Dockerfile(s). Accepts shell expansions (**/Dockerfile)
config_file Path to optional config (hadolint defaults to read ./hadolint.yml if it exists)
error_level 0 Fail CI if hadolint emits output (-1: never, 0: error, 1: warning, 2: info)
annotate true Annotate code inline in the github PR viewer (true/false)
output_format Set output format (choose between tty, json, checkstyle, codeclimate or gitlab_codeclimate)
hadolint_path Absolute path to hadolint binary. If unset, it is assumed to exist in $PATH

Hadolint version

The variable hadolint_version will always contain what version the action is running. This can be useful in debugging scenarios where things "break" from one day to the other due to the action being updated.

Output

You can control the behavior of how hadolint presents its findings by configuring:

  • annotate: let feedback show inline in your code review
  • output_format: store the output in a variable you can pass on to other processing tools

If output_format is set, the github action variable hadolint_output will be set. You can choose what format you prefer depending on how you want to process the results.

Robustness

Also known as "can I run this in production". The action itself is tested via CI for all its use cases as well as unit tests for each function. Additionally, shellcheck is run against all shell scripts. Releases are cut manually (for now) and the action will strictly follow semver with regards to breaking functionality or options.

Performance

Due to staying with bash we can avoid Docker-related performance penalties. Yet to be benchmarked, but it is likely on par or faster than other hadolint actions.