mirror of
https://github.com/hadolint/hadolint-action.git
synced 2026-07-13 20:11:38 +00:00
Compare commits
38 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0a6d062e78 | |||
| 0b08ca228d | |||
| 9a555bc2d4 | |||
| e8cde77aa0 | |||
| bc86787e19 | |||
| d2b4ab26ff | |||
| 2bcb99c6e2 | |||
| 63666e594d | |||
| 96339c1113 | |||
| 37f399667b | |||
| aa70df94a2 | |||
| 0bc6199b82 | |||
| 070f68df71 | |||
| 40f98da752 | |||
| 390bcfc1bc | |||
| 98fb3f8040 | |||
| 3cfc69d4b2 | |||
| 03ff2f358b | |||
| d7b3858233 | |||
| fdf6f4b6d2 | |||
| 0bb0c4c131 | |||
| 8af94d9fae | |||
| afcbb72a70 | |||
| 34545a185d | |||
| 1fe9ddfd12 | |||
| 64243a4c85 | |||
| 9c70326916 | |||
| 6c5b4b97b1 | |||
| f49a60108f | |||
| 5f549be9cc | |||
| c27bd9edc1 | |||
| 110e47c1b7 | |||
| 785eabb2d4 | |||
| 136c22c8f8 | |||
| 473e36ba30 | |||
| edc054086d | |||
| b18c7cf9dc | |||
| 20e70041a2 |
@@ -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
|
|
||||||
@@ -39,11 +39,51 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
- name: Run integration test
|
- name: Run integration test 1
|
||||||
uses: ./
|
uses: ./
|
||||||
with:
|
with:
|
||||||
dockerfile: testdata/Dockerfile
|
dockerfile: testdata/Dockerfile
|
||||||
|
|
||||||
|
- name: Run integration test 2 - ignore a rule
|
||||||
|
# This step is supposed to print out an info level rule violation
|
||||||
|
# but completely ignore the two rules listed below
|
||||||
|
uses: ./
|
||||||
|
with:
|
||||||
|
dockerfile: testdata/warning.Dockerfile
|
||||||
|
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
|
||||||
|
# because of the high failure threshold.
|
||||||
|
uses: ./
|
||||||
|
with:
|
||||||
|
dockerfile: testdata/info.Dockerfile
|
||||||
|
failure-threshold: warning
|
||||||
|
|
||||||
|
- name: Run integration test 4 - output format
|
||||||
|
# This step will never fail, but will print out rule violations as json.
|
||||||
|
uses: ./
|
||||||
|
with:
|
||||||
|
dockerfile: testdata/warning.Dockerfile
|
||||||
|
failure-threshold: error
|
||||||
|
format: json
|
||||||
|
|
||||||
|
- 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:
|
release:
|
||||||
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
|
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
|
||||||
name: Release
|
name: Release
|
||||||
|
|||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
FROM hadolint/hadolint:v1.19.0-alpine
|
FROM hadolint/hadolint:v2.9.3-debian
|
||||||
|
|
||||||
COPY LICENSE README.md problem-matcher.json /
|
COPY LICENSE README.md problem-matcher.json /
|
||||||
COPY hadolint.sh /usr/local/bin/hadolint.sh
|
COPY hadolint.sh /usr/local/bin/hadolint.sh
|
||||||
|
|||||||
@@ -7,7 +7,7 @@
|
|||||||
[](http://commitizen.github.io/cz-cli/)
|
[](http://commitizen.github.io/cz-cli/)
|
||||||
[](https://github.com/semantic-release/semantic-release?style=for-the-badge)
|
[](https://github.com/semantic-release/semantic-release?style=for-the-badge)
|
||||||
|
|
||||||
[](https://github.com/brpaz/hadolint-action/action)
|
[](https://github.com/hadolint/hadolint-action/action)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@@ -15,22 +15,47 @@ Add the following step to your workflow configuration:
|
|||||||
|
|
||||||
```yml
|
```yml
|
||||||
steps:
|
steps:
|
||||||
- uses: brpaz/hadolint-action@v1.2.1
|
- uses: actions/checkout@v2
|
||||||
with:
|
- uses: hadolint/hadolint-action@v1.6.0
|
||||||
dockerfile: Dockerfile
|
with:
|
||||||
|
dockerfile: Dockerfile
|
||||||
```
|
```
|
||||||
|
|
||||||
## Inputs
|
## Inputs
|
||||||
|
|
||||||
| Name | Description | Default |
|
| Name | Description | Default |
|
||||||
|------------ |----------------------------------------- |-------------- |
|
|------------------- |------------------------------------------ |----------------- |
|
||||||
| dockerfile | The path to the Dockerfile to be tested | ./Dockerfile |
|
| 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-registries | List of urls of trusted registries | |
|
||||||
|
|
||||||
## Hadolint Configuration
|
## 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).
|
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
|
## 🤝 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**.
|
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**.
|
||||||
@@ -43,17 +68,12 @@ Contributions are what make the open source community such an amazing place to b
|
|||||||
|
|
||||||
## 💛 Support the project
|
## 💛 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.
|
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).
|
||||||
|
|
||||||
[](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
|
## Author
|
||||||
|
|
||||||
👤 **Bruno Paz**
|
👤 **Bruno Paz**
|
||||||
@@ -63,6 +83,4 @@ Or if you prefer a one time donation to the project, you can simple:
|
|||||||
|
|
||||||
## 📝 License
|
## 📝 License
|
||||||
|
|
||||||
Copyright © 2019 [Bruno Paz](https://github.com/brpaz).
|
[MIT](LICENSE)
|
||||||
|
|
||||||
This project is [MIT](LICENSE) licensed.
|
|
||||||
|
|||||||
+85
@@ -3,13 +3,98 @@ description: 'Action that runs Hadolint Dockerfile linting tool'
|
|||||||
author: 'Bruno Paz'
|
author: 'Bruno Paz'
|
||||||
inputs:
|
inputs:
|
||||||
dockerfile:
|
dockerfile:
|
||||||
|
required: false
|
||||||
description: 'The path to the Dockerfile to lint'
|
description: 'The path to the Dockerfile to lint'
|
||||||
default: 'Dockerfile'
|
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 | codacy | sarif]
|
||||||
|
default: 'tty'
|
||||||
|
failure-threshold:
|
||||||
|
required: false
|
||||||
|
description: |
|
||||||
|
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 comma separated string of rules to ignore'
|
||||||
|
default:
|
||||||
|
trusted-registries:
|
||||||
|
required: false
|
||||||
|
description: 'A comma separated list of trusted registry urls'
|
||||||
|
default:
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
using: 'docker'
|
using: 'docker'
|
||||||
image: 'Dockerfile'
|
image: 'Dockerfile'
|
||||||
args:
|
args:
|
||||||
- ${{ inputs.dockerfile }}
|
- ${{ inputs.dockerfile }}
|
||||||
|
env:
|
||||||
|
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:
|
branding:
|
||||||
icon: 'layers'
|
icon: 'layers'
|
||||||
color: 'purple'
|
color: 'purple'
|
||||||
|
|||||||
+37
-10
@@ -1,22 +1,49 @@
|
|||||||
#!/bin/sh
|
#!/bin/bash
|
||||||
|
|
||||||
# The problem-matcher definition must be present in the repository
|
# The problem-matcher definition must be present in the repository
|
||||||
# checkout (outside the Docker container running hadolint). We create
|
# checkout (outside the Docker container running hadolint). We copy
|
||||||
# a temporary folder and copy problem-matcher.json to it and make it
|
# problem-matcher.json to the home folder.
|
||||||
# readable.
|
cp /problem-matcher.json "$HOME/"
|
||||||
TMP_FOLDER=$(mktemp -d -p .)
|
|
||||||
cp /problem-matcher.json "${TMP_FOLDER}"
|
|
||||||
chmod -R a+rX "${TMP_FOLDER}"
|
|
||||||
|
|
||||||
# After the run has finished we remove the problem-matcher.json from
|
# 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 repository so we don't leave the checkout dirty. We also remove
|
||||||
# the matcher so it won't take effect in later steps.
|
# the matcher so it won't take effect in later steps.
|
||||||
cleanup() {
|
cleanup() {
|
||||||
echo "::remove-matcher owner=brpaz/hadolint-action::"
|
echo "::remove-matcher owner=brpaz/hadolint-action::"
|
||||||
rm -rf "${TMP_FOLDER}"
|
|
||||||
}
|
}
|
||||||
trap cleanup EXIT
|
trap cleanup EXIT
|
||||||
|
|
||||||
echo "::add-matcher::${TMP_FOLDER}/problem-matcher.json"
|
echo "::add-matcher::$HOME/problem-matcher.json"
|
||||||
|
|
||||||
hadolint "$@"
|
if [ -n "$HADOLINT_CONFIG" ]; then
|
||||||
|
HADOLINT_CONFIG="-c ${HADOLINT_CONFIG}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "$HADOLINT_TRUSTED_REGISTRIES" ]; then
|
||||||
|
unset HADOLINT_TRUSTED_REGISTRIES;
|
||||||
|
fi
|
||||||
|
|
||||||
|
OUTPUT=
|
||||||
|
if [ -n "$HADOLINT_OUTPUT" ]; then
|
||||||
|
if [ -f "$HADOLINT_OUTPUT" ]; then
|
||||||
|
HADOLINT_OUTPUT="$TMP_FOLDER/$HADOLINT_OUTPUT"
|
||||||
|
fi
|
||||||
|
OUTPUT=" | tee $HADOLINT_OUTPUT"
|
||||||
|
fi
|
||||||
|
|
||||||
|
FAILED=0
|
||||||
|
if [ "$HADOLINT_RECURSIVE" = "true" ]; then
|
||||||
|
shopt -s globstar
|
||||||
|
|
||||||
|
filename="${!#}"
|
||||||
|
flags="${@:1:$#-1}"
|
||||||
|
|
||||||
|
hadolint $HADOLINT_CONFIG $flags **/$filename $OUTPUT || FAILED=1
|
||||||
|
else
|
||||||
|
# shellcheck disable=SC2086
|
||||||
|
hadolint $HADOLINT_CONFIG "$@" $OUTPUT || FAILED=1
|
||||||
|
fi
|
||||||
|
|
||||||
|
[ -z "$HADOLINT_OUTPUT" ] || echo "Hadolint output saved to: $HADOLINT_OUTPUT"
|
||||||
|
|
||||||
|
exit $FAILED
|
||||||
|
|||||||
Vendored
+1
@@ -0,0 +1 @@
|
|||||||
|
failure-threshold: error
|
||||||
Vendored
+5
@@ -0,0 +1,5 @@
|
|||||||
|
FROM debian:buster
|
||||||
|
|
||||||
|
# info level warning expected here:
|
||||||
|
RUN echo "Hello"
|
||||||
|
RUN echo "World"
|
||||||
Vendored
+4
@@ -0,0 +1,4 @@
|
|||||||
|
FROM debian:buster
|
||||||
|
|
||||||
|
# emits an info and a warning level violation.
|
||||||
|
RUN apt-get install foo
|
||||||
Reference in New Issue
Block a user