mirror of
https://github.com/hadolint/hadolint-action.git
synced 2026-07-06 08:31:42 +00:00
Compare commits
16 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| d7b3858233 | |||
| fdf6f4b6d2 | |||
| 0bb0c4c131 | |||
| 8af94d9fae | |||
| afcbb72a70 | |||
| 34545a185d | |||
| 1fe9ddfd12 | |||
| 64243a4c85 | |||
| 9c70326916 | |||
| 6c5b4b97b1 | |||
| f49a60108f | |||
| 5f549be9cc | |||
| c27bd9edc1 | |||
| 110e47c1b7 | |||
| 785eabb2d4 | |||
| 136c22c8f8 |
@@ -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,42 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Run integration test
|
||||
- name: Run integration test 1
|
||||
uses: ./
|
||||
with:
|
||||
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 DL3015
|
||||
|
||||
- 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 4 - output format
|
||||
# This step will never fail, but will print out rule violations.
|
||||
uses: ./
|
||||
with:
|
||||
dockerfile: testdata/warning.Dockerfile
|
||||
config: testdata/hadolint.yaml
|
||||
|
||||
release:
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
|
||||
name: Release
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
FROM hadolint/hadolint:v2.1.0-alpine
|
||||
FROM hadolint/hadolint:v2.7.0-debian
|
||||
|
||||
COPY LICENSE README.md problem-matcher.json /
|
||||
COPY hadolint.sh /usr/local/bin/hadolint.sh
|
||||
|
||||
@@ -15,22 +15,33 @@ Add the following step to your workflow configuration:
|
||||
|
||||
```yml
|
||||
steps:
|
||||
- uses: hadolint/hadolint-action@v1.3.1
|
||||
with:
|
||||
dockerfile: Dockerfile
|
||||
- uses: actions/checkout@v2
|
||||
- uses: hadolint/hadolint-action@v1.5.0
|
||||
with:
|
||||
dockerfile: Dockerfile
|
||||
```
|
||||
|
||||
## Inputs
|
||||
|
||||
| Name | Description | Default |
|
||||
|------------ |----------------------------------------- |-------------- |
|
||||
| dockerfile | The path to the Dockerfile to be tested | ./Dockerfile |
|
||||
| Name | Description | Default |
|
||||
|------------------ |------------------------------------------ |----------------- |
|
||||
| dockerfile | The path to the Dockerfile to be tested | ./Dockerfile |
|
||||
| recursive | Search for specified dockerfile | false |
|
||||
| | recursively, from the project root | |
|
||||
| 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] | |
|
||||
|
||||
## 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**.
|
||||
@@ -40,20 +51,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).
|
||||
|
||||
[](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**
|
||||
@@ -63,6 +68,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)
|
||||
|
||||
+34
@@ -3,13 +3,47 @@ description: 'Action that runs Hadolint Dockerfile linting tool'
|
||||
author: 'Bruno Paz'
|
||||
inputs:
|
||||
dockerfile:
|
||||
required: false
|
||||
description: 'The path to the Dockerfile to lint'
|
||||
default: 'Dockerfile'
|
||||
recursive:
|
||||
required: false
|
||||
description: 'Search for specified dockerfile recursively, from the project root'
|
||||
default: 'false'
|
||||
format:
|
||||
required: false
|
||||
description: |
|
||||
The output format, one of [tty (default) | json | checkstyle |
|
||||
codeclimate | gitlab_codeclimate ]
|
||||
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'
|
||||
ignore:
|
||||
required: false
|
||||
description: 'A space separated string of rules to ignore'
|
||||
default:
|
||||
config:
|
||||
required: false
|
||||
description: 'Path to a config file'
|
||||
default:
|
||||
|
||||
runs:
|
||||
using: 'docker'
|
||||
image: 'Dockerfile'
|
||||
args:
|
||||
- -f
|
||||
- ${{ inputs.format }}
|
||||
- -t
|
||||
- ${{ inputs.failure-threshold }}
|
||||
- ${{ inputs.dockerfile }}
|
||||
env:
|
||||
HADOLINT_CONFIG: ${{ inputs.config }}
|
||||
HADOLINT_IGNORE: ${{ inputs.ignore }}
|
||||
HADOLINT_RECURSIVE: ${{ inputs.recursive }}
|
||||
branding:
|
||||
icon: 'layers'
|
||||
color: 'purple'
|
||||
|
||||
+20
-2
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
# The problem-matcher definition must be present in the repository
|
||||
# checkout (outside the Docker container running hadolint). We create
|
||||
@@ -19,4 +19,22 @@ trap cleanup EXIT
|
||||
|
||||
echo "::add-matcher::${TMP_FOLDER}/problem-matcher.json"
|
||||
|
||||
hadolint "$@"
|
||||
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
|
||||
|
||||
if [ "$HADOLINT_RECURSIVE" = "true" ]; then
|
||||
shopt -s globstar
|
||||
|
||||
filename="${!#}"
|
||||
flags="${@:1:$#-1}"
|
||||
|
||||
hadolint $HADOLINT_IGNORE_CMDLINE $HADOLINT_CONFIG $flags **/$filename
|
||||
else
|
||||
# shellcheck disable=SC2086
|
||||
hadolint $HADOLINT_IGNORE_CMDLINE $HADOLINT_CONFIG "$@"
|
||||
fi
|
||||
|
||||
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