upgrade to 2.9.2

features: config options, saving to file, SARIF

.github/FUNDING.yml

@@ -1,4 +0,0 @@
-# https://help.github.com/en/articles/displaying-a-sponsor-button-in-your-repository
-github: brpaz
-patreon: brpaz
-custom: https://www.buymeacoffee.com/Z1Bu6asGV

.github/workflows/ci.yml

@@ -50,7 +50,8 @@ jobs:
         uses: ./
         with:
           dockerfile: testdata/warning.Dockerfile
-          ignore: DL3014 DL3008
+          ignore: 'DL3014,DL3008'
+          no-fail: true
 
       - name: Run integration test 3 - set failure threshold
         # This step will print out an info level rule violation, but not fail
@@ -68,13 +69,21 @@ jobs:
           failure-threshold: error
           format: json
 
-      - name: Run integration test 4 - output format
+      - name: Run integration test 5 - output format
         # This step will never fail, but will print out rule violations.
         uses: ./
         with:
           dockerfile: testdata/warning.Dockerfile
           config: testdata/hadolint.yaml
 
+      - name: Run integration test 6 - output to file
+        # This step will never fail, but will print out rule violations.
+        uses: ./
+        with:
+          dockerfile: testdata/warning.Dockerfile
+          format: sarif
+          output-file: /report.sarif
+
   release:
     if: github.event_name == 'push' && github.ref == 'refs/heads/master'
     name: Release

Dockerfile

@@ -1,4 +1,4 @@
-FROM hadolint/hadolint:v2.4.0-debian
+FROM hadolint/hadolint:v2.9.2-debian
 
 COPY LICENSE README.md problem-matcher.json /
 COPY hadolint.sh /usr/local/bin/hadolint.sh

README.md

@@ -15,31 +15,47 @@ Add the following step to your workflow configuration:
 
 ```yml
 steps:
-  - uses: hadolint/hadolint-action@v1.4.0
+  - uses: actions/checkout@v2 
+  - uses: hadolint/hadolint-action@v1.6.0
     with:
       dockerfile: Dockerfile
 ```
 
 ## Inputs
 
-| Name              | Description                               | Default          |
-|------------------ |------------------------------------------ |----------------- |
-| dockerfile        | The path to the Dockerfile to be tested   | ./Dockerfile     |
-| format            | The output format. One of [tty | json |   | tty              |
-|                   | checkstyle | codeclimate |                |                  |
-|                   | gitlab_codeclimate]                       |                  |
-| ignore            | Space separated list of Hadolint rules to | <none>           |
-|                   | ignore.                                   |                  |
-| config            | Custom path to a Hadolint config file     | ./.hadolint.yaml |
-| failure-threshold | Rule severity threshold for pipeline      | info             |
-|                   | failure. One of [error | warning | info | |                  |
-|                   | style | ignore]                           |                  |
+| Name               | Description                               | Default          |
+|------------------- |------------------------------------------ |----------------- |
+| dockerfile         | The path to the Dockerfile to be tested   | ./Dockerfile     |
+| recursive          | Search for specified dockerfile           | false            |
+|                    | recursively, from the project root        |                  |
+| config             | Custom path to a Hadolint config file     | ./.hadolint.yaml |
+| output-file        | A sub-path where to save the              |                  |
+|                    | output as a file to                       |                  |
+| no-color           | Don't create colored output               |                  |
+| no-fail            | Never fail the action                     |                  |
+| verbose            | Output more information                   |                  |
+| format             | The output format. One of [tty \| json \| | tty              |
+|                    | checkstyle \| codeclimate \|              |                  |
+|                    | gitlab_codeclimate \| codacy \| sarif]    |                  |
+| failure-threshold  | Rule severity threshold for pipeline      | info             |
+|                    | failure. One of [error \| warning \|      |                  |
+|                    | info \| style \| ignore]                  |                  |
+| override-error     | List of rules to treat with 'error'       |                  |
+|                    | severity                                  |                  |
+| override-warning   | List of rules to treat with 'warning'     |                  |
+|                    | severity                                  |                  |
+| override-info      | List of rules to treat with 'info'        |                  |
+|                    | severity                                  |                  |
+| override-style     | List of rules to treat with 'style'       |                  |
+|                    | severity                                  |                  |
+| ignore             | Space separated list of Hadolint rules to | <none>           |
+|                    | ignore.                                   |                  |
+| trusted-resgitries | List of urls of trusted registries        |                  |
 
 ## Hadolint Configuration
 
 To configure Hadolint (for example ignore rules), you can create an `.hadolint.yaml` file in the root of your repository. Please check the Hadolint [documentation](https://github.com/hadolint/hadolint#configure).
 
-
 ## 🤝 Contributing
 
 Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
@@ -49,20 +65,14 @@ Contributions are what make the open source community such an amazing place to b
 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
 4. Push to the Branch (`git push origin feature/AmazingFeature`)
 5. Open a Pull Request
-
 ## 💛 Support the project
 
-If this project was useful to you in some form, I would be glad to have your support.  It will help to keep the project alive and to have more time to work on Open Source.
+If this project was useful to you in some form, We would be glad to have your support. It will help keeping the project alive.
 
 The sinplest form of support is to give a ⭐️ to this repo.
 
-You can also contribute with [GitHub Sponsors](https://github.com/sponsors/brpaz).
+This project was originally created by [Bruno Paz](https://github.com/sponsors/brpaz) and incorporated into the Hadolint organization. If you appreciate the work done on this action, Bruno would be happy with your [sponsorship](https://github.com/sponsors/brpaz).
 
-[![GitHub Sponsors](https://img.shields.io/badge/GitHub%20Sponsors-Sponsor%20Me-red?style=for-the-badge)](https://github.com/sponsors/brpaz)
-
-Or if you prefer a one time donation to the project, you can simple:
-
-<a href="https://www.buymeacoffee.com/Z1Bu6asGV" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
 ## Author
 
 👤 **Bruno Paz**
@@ -72,6 +82,4 @@ Or if you prefer a one time donation to the project, you can simple:
 
 ## 📝 License
 
-Copyright © 2019 [Bruno Paz](https://github.com/brpaz).
-
-This project is [MIT](LICENSE) licensed.
+[MIT](LICENSE)

action.yml

@@ -6,11 +6,38 @@ inputs:
     required: false
     description: 'The path to the Dockerfile to lint'
     default: 'Dockerfile'
+  config:
+    required: false
+    description: 'Path to a config file'
+    default:
+  recursive:
+    required: false
+    description:
+      'Search for specified dockerfile recursively, from the project root'
+    default: 'false'
+  output-file:
+    required: false
+    description: 'The path where to save the linting results to'
+    default:
+
+  # standart hadolint options:
+  no-color:
+    required: false
+    description: Don't create colored output.
+    default: 'false'
+  no-fail:
+    required: false
+    description: Never exit with a failure status code
+    default: 'false'
+  verbose:
+    required: false
+    description: Print more information about the running config
+    default: 'false'
   format:
     required: false
     description: |
       The output format, one of [tty (default) | json | checkstyle |
-      codeclimate | gitlab_codeclimate ]
+      codeclimate | gitlab_codeclimate | codacy | sarif]
     default: 'tty'
   failure-threshold:
     required: false
@@ -18,27 +45,56 @@ inputs:
       Fail the pipeline only if rules with severity above this threshold are
       violated. One of [error | warning | info (default) | style | ignore]
     default: 'info'
+  override-error:
+    required: false
+    description:
+      'A comma separated list of rules whose severity will be `error`'
+    default:
+  override-warning:
+    required: false
+    description:
+      'A comma separated list of rules whose severity will be `warning`'
+    default:
+  override-info:
+    required: false
+    description:
+      'A comma separated list of rules whose severity will be `info`'
+    default:
+  override-style:
+    required: false
+    description:
+      'A comma separated list of rules whose severity will be `style`'
+    default:
   ignore:
     required: false
-    description: 'A space separated string of rules to ignore'
+    description: 'A comma separated string of rules to ignore'
     default:
-  config:
+  trusted-registries:
     required: false
-    description: 'Path to a config file'
+    description: 'A comma separated list of trusted registry urls'
     default:
 
 runs:
   using: 'docker'
   image: 'Dockerfile'
   args:
-    - -f
-    - ${{ inputs.format }}
-    - -t
-    - ${{ inputs.failure-threshold }}
     - ${{ inputs.dockerfile }}
   env:
-    HADOLINT_CONFIG: ${{ inputs.config }}
+    NO_COLOR: ${{ inputs.no-color }}
+    HADOLINT_NOFAIL: ${{ inputs.no-fail }}
+    HADOLINT_VERBOSE: ${{ inputs.verbose }}
+    HADOLINT_FORMAT: ${{ inputs.format }}
+    HADOLINT_FAILURE_THRESHOLD: ${{ inputs.failure-threshold }}
+    HADOLINT_OVERRIDE_ERROR: ${{ inputs.override-error }}
+    HADOLINT_OVERRIDE_WARNING: ${{ inputs.override-warning }}
+    HADOLINT_OVERRIDE_INFO: ${{ inputs.override-info }}
+    HADOLINT_OVERRIDE_STYLE: ${{ inputs.override-style }}
     HADOLINT_IGNORE: ${{ inputs.ignore }}
+    HADOLINT_TRUSTED_REGISTRIES: ${{ inputs.trusted-registries }}
+
+    HADOLINT_CONFIG: ${{ inputs.config }}
+    HADOLINT_RECURSIVE: ${{ inputs.recursive }}
+    HADOLINT_OUTPUT: ${{ inputs.output-file }}
 branding:
   icon: 'layers'
   color: 'purple'

hadolint.sh

@@ -1,31 +1,42 @@
-#!/bin/sh
+#!/bin/bash
 
 # The problem-matcher definition must be present in the repository
-# checkout (outside the Docker container running hadolint). We create
-# a temporary folder and copy problem-matcher.json to it and make it
-# readable.
-TMP_FOLDER=$(mktemp -d -p .)
-cp /problem-matcher.json "${TMP_FOLDER}"
-chmod -R a+rX "${TMP_FOLDER}"
+# checkout (outside the Docker container running hadolint). We copy
+# problem-matcher.json to the home folder.
+cp /problem-matcher.json "$HOME/"
 
 # After the run has finished we remove the problem-matcher.json from
 # the repository so we don't leave the checkout dirty. We also remove
 # the matcher so it won't take effect in later steps.
 cleanup() {
     echo "::remove-matcher owner=brpaz/hadolint-action::"
-    rm -rf "${TMP_FOLDER}"
 }
 trap cleanup EXIT
 
-echo "::add-matcher::${TMP_FOLDER}/problem-matcher.json"
+echo "::add-matcher::$HOME/problem-matcher.json"
 
 if [ -n "$HADOLINT_CONFIG" ]; then
   HADOLINT_CONFIG="-c ${HADOLINT_CONFIG}"
 fi
 
-for i in $HADOLINT_IGNORE; do
-  HADOLINT_IGNORE_CMDLINE="${HADOLINT_IGNORE_CMDLINE} --ignore=${i}"
-done
+OUTPUT=
+if [ -n "$HADOLINT_OUTPUT" ]; then
+  if [ -f "$HADOLINT_OUTPUT" ]; then
+    HADOLINT_OUTPUT="$TMP_FOLDER/$HADOLINT_OUTPUT"
+  fi
+  OUTPUT=" | tee $HADOLINT_OUTPUT"
+fi
 
-# shellcheck disable=SC2086
-hadolint $HADOLINT_IGNORE_CMDLINE $HADOLINT_CONFIG "$@"
+if [ "$HADOLINT_RECURSIVE" = "true" ]; then
+  shopt -s globstar
+
+  filename="${!#}"
+  flags="${@:1:$#-1}"
+
+  hadolint $HADOLINT_CONFIG $flags **/$filename $OUTPUT
+else
+  # shellcheck disable=SC2086
+  hadolint $HADOLINT_CONFIG "$@" $OUTPUT
+fi
+
+[ -z "$HADOLINT_OUTPUT" ] || echo "Hadolint output saved to: $HADOLINT_OUTPUT"