Compare commits

..

No commits in common. "master" and "v1.6.0" have entirely different histories.

6 changed files with 65 additions and 225 deletions

View file

@ -3,49 +3,27 @@ on:
push: push:
branches: branches:
- master - master
pull_request: pull_request:
env: env:
TEST_IMAGE_NAME: hadolint-action:${{github.sha}} TEST_IMAGE_NAME: hadolint-action:${{github.sha}}
permissions:
contents: write
issues: write # Used by Release step to update "The automated release is failing" issue
pull-requests: write # Used by ShellCheck Action to add comments on PR
jobs: jobs:
lint: lint:
name: Lint name: Lint
runs-on: ubuntu-24.04 runs-on: ubuntu-20.04
container: pipelinecomponents/hadolint:0.27.2 container: pipelinecomponents/hadolint:0.10.1
steps: steps:
- uses: actions/checkout@v5 - uses: actions/checkout@v2
- name: Run hadolint - name: Run hadolint
run: hadolint Dockerfile run: hadolint Dockerfile
shellcheck:
name: ShellCheck
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v5
- name: Run ShellCheck
uses: reviewdog/action-shellcheck@v1.31.0
with:
reporter: github-pr-review
fail_on_error: true
build-test: build-test:
name: Build and Test name: Build and Test
runs-on: ubuntu-24.04 runs-on: ubuntu-20.04
needs: needs: ["lint"]
- lint
- shellcheck
steps: steps:
- uses: actions/checkout@v5 - uses: actions/checkout@v2
- name: Build Docker image - name: Build Docker image
run: docker build -t $TEST_IMAGE_NAME . run: docker build -t $TEST_IMAGE_NAME .
@ -56,11 +34,10 @@ jobs:
integration-tests: integration-tests:
name: Integration Tests name: Integration Tests
runs-on: ubuntu-24.04 runs-on: ubuntu-20.04
needs: needs: build-test
- build-test
steps: steps:
- uses: actions/checkout@v5 - uses: actions/checkout@v2
- name: Run integration test 1 - name: Run integration test 1
uses: ./ uses: ./
@ -73,8 +50,7 @@ jobs:
uses: ./ uses: ./
with: with:
dockerfile: testdata/warning.Dockerfile dockerfile: testdata/warning.Dockerfile
ignore: 'DL3014,DL3008' ignore: DL3014 DL3008 DL3015
no-fail: true
- name: Run integration test 3 - set failure threshold - name: Run integration test 3 - set failure threshold
# This step will print out an info level rule violation, but not fail # This step will print out an info level rule violation, but not fail
@ -92,48 +68,21 @@ jobs:
failure-threshold: error failure-threshold: error
format: json format: json
- name: Run integration test 5 - config file - name: Run integration test 4 - output format
# This step will never fail, but will print out rule violations # This step will never fail, but will print out rule violations.
# because in config is set the error failure threshold.
id: hadolint5
uses: ./ uses: ./
with: with:
dockerfile: testdata/warning.Dockerfile dockerfile: testdata/warning.Dockerfile
config: testdata/hadolint.yaml config: testdata/hadolint.yaml
- name: Run integration test 6 - verify results output parameter
# This step will never fail, but will print out the results from step5
env:
results: ${{ steps.hadolint5.outputs.results }}
run: echo "$results"
- name: Run integration test 7 - set recursive
# This step will never fail, but will print out rule violations
# for all the Dockerfiles in repository.
uses: ./
with:
dockerfile: "*Dockerfile"
failure-threshold: error
recursive: true
#- name: Run integration test 8 - 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
runs-on: ubuntu-24.04 runs-on: ubuntu-20.04
needs: needs: integration-tests
- integration-tests
steps: steps:
- uses: actions/checkout@v5 - uses: actions/checkout@v2
- uses: cycjimmy/semantic-release-action@v2
- uses: cycjimmy/semantic-release-action@v5
with: with:
extra_plugins: | extra_plugins: |
@semantic-release/git @semantic-release/git

View file

@ -1,4 +1,4 @@
FROM ghcr.io/hadolint/hadolint:v2.14.0-debian FROM hadolint/hadolint:v2.7.0-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

View file

@ -1,7 +1,7 @@
IMAGE_NAME:=hadolint-action IMAGE_NAME:=hadolint-action
lint-dockerfile: ## Runs hadolint against application dockerfile lint-dockerfile: ## Runs hadoint against application dockerfile
@docker run --rm -v "$(PWD):/data" -w "/data" hadolint/hadolint hadolint Dockerfile @docker run --rm -v "$(PWD):/data" -w "/data" hadolint/hadolint hadolint Dockerfile
lint-yaml: ## Lints yaml configurations lint-yaml: ## Lints yaml configurations
@ -12,8 +12,8 @@ build: ## Builds the docker image
test: build ## Runs a test in the image test: build ## Runs a test in the image
@docker run -i --rm \ @docker run -i --rm \
-v /var/run/docker.sock:/var/run/docker.sock \ -v /var/run/docker.sock:/var/run/docker.sock \
-v ${PWD}:/test zemanlx/container-structure-test:v1.8.0-alpine \ -v ${PWD}:/test zemanlx/container-structure-test:v1.8.0-alpine \
test \ test \
--image $(IMAGE_NAME) \ --image $(IMAGE_NAME) \
--config test/structure-tests.yaml --config test/structure-tests.yaml

View file

@ -6,8 +6,8 @@
[![License](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](LICENSE) [![License](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](LICENSE)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge)](http://commitizen.github.io/cz-cli/) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge)](http://commitizen.github.io/cz-cli/)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release?style=for-the-badge) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release?style=for-the-badge)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/hadolint/hadolint-action/ci.yml?branch=master&style=for-the-badge)](https://github.com/hadolint/hadolint-action/action)
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/hadolint/hadolint-action/CI?style=for-the-badge)](https://github.com/hadolint/hadolint-action/action)
## Usage ## Usage
@ -15,58 +15,28 @@ Add the following step to your workflow configuration:
```yml ```yml
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v2
- uses: hadolint/hadolint-action@v3.1.0 - uses: hadolint/hadolint-action@v1.5.0
with: with:
dockerfile: Dockerfile 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 </br> recursively, from the project root | `false` | | recursive | Search for specified dockerfile | false |
| `config` | Custom path to a Hadolint config file | `./.hadolint.yaml` | | | recursively, from the project root | |
| `output-file` | A sub-path where to save the </br> output as a file to | `/dev/stdout` | | format | The output format. One of [tty \| json \| | tty |
| `no-color` | Don't create colored output (`true`/`false`) | `false` | | | checkstyle \| codeclimate \| | |
| `no-fail` | Never fail the action (`true`/`false`) | `false` | | | gitlab_codeclimate] | |
| `verbose` | Output more information (`true`/`false`) | `false` | | ignore | Space separated list of Hadolint rules to | <none> |
| `format` | The output format. One of [`tty` \| `json` \| </br> `checkstyle` \| `codeclimate` \| </br> `gitlab_codeclimate` \| `codacy` \| `sarif`] | `tty` | | | ignore. | |
| `failure-threshold` | Rule severity threshold for pipeline </br> failure. One of [`error` \| `warning` \| </br> `info` \| `style` \| `ignore`] | `info` | | config | Custom path to a Hadolint config file | ./.hadolint.yaml |
| `override-error` | Comma separated list of rules to treat with `error` severity | | | failure-threshold | Rule severity threshold for pipeline | info |
| `override-warning` | Comma separated list of rules to treat with `warning` severity | | | | failure. One of [error \| warning \| | |
| `override-info` | Comma separated list of rules to treat with `info` severity | | | | info \| style \| ignore] | |
| `override-style` | Comma separated list of rules to treat with `style` severity | |
| `ignore` | Comma separated list of Hadolint rules to ignore. | <none> |
| `trusted-registries` | Comma separated list of urls of trusted registries | |
## Output
The Action will store results in an environment variable that can be used in other steps in a workflow.
Example to create a comment in a PR:
```
- name: Update Pull Request
uses: actions/github-script@v6
if: github.event_name == 'pull_request'
with:
script: |
const output = `
#### Hadolint: \`${{ steps.hadolint.outcome }}\`
\`\`\`
${process.env.HADOLINT_RESULTS}
\`\`\`
`;
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: output
})
```
## Hadolint Configuration ## Hadolint Configuration
@ -81,7 +51,6 @@ Contributions are what make the open source community such an amazing place to b
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`) 4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request 5. Open a Pull Request
## đź’› Support the project ## đź’› Support the project
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. 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.

View file

@ -6,38 +6,15 @@ inputs:
required: false 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: recursive:
required: false required: false
description: description: 'Search for specified dockerfile recursively, from the project root'
'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: "/dev/stdout"
# 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' default: 'false'
format: format:
required: false required: false
description: | description: |
The output format, one of [tty (default) | json | checkstyle | The output format, one of [tty (default) | json | checkstyle |
codeclimate | gitlab_codeclimate | codacy | sarif] codeclimate | gitlab_codeclimate ]
default: 'tty' default: 'tty'
failure-threshold: failure-threshold:
required: false required: false
@ -45,56 +22,28 @@ inputs:
Fail the pipeline only if rules with severity above this threshold are Fail the pipeline only if rules with severity above this threshold are
violated. One of [error | warning | info (default) | style | ignore] violated. One of [error | warning | info (default) | style | ignore]
default: 'info' 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: ignore:
required: false required: false
description: 'A comma separated string of rules to ignore' description: 'A space separated string of rules to ignore'
default: default:
trusted-registries: config:
required: false required: false
description: 'A comma separated list of trusted registry urls' description: 'Path to a config file'
default: default:
runs: runs:
using: 'docker' using: 'docker'
image: 'Dockerfile' image: 'Dockerfile'
args: args:
- -f
- ${{ inputs.format }}
- -t
- ${{ inputs.failure-threshold }}
- ${{ inputs.dockerfile }} - ${{ inputs.dockerfile }}
env: 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_CONFIG: ${{ inputs.config }}
HADOLINT_IGNORE: ${{ inputs.ignore }}
HADOLINT_RECURSIVE: ${{ inputs.recursive }} HADOLINT_RECURSIVE: ${{ inputs.recursive }}
HADOLINT_OUTPUT: ${{ inputs.output-file }}
branding: branding:
icon: 'layers' icon: 'layers'
color: 'purple' color: 'purple'

View file

@ -1,67 +1,40 @@
#!/bin/bash #!/bin/bash
# The problem-matcher definition must be present in the repository
# checkout (outside the Docker container running hadolint). We copy
# problem-matcher.json to the home folder.
PROBLEM_MATCHER_FILE="/problem-matcher.json" # The problem-matcher definition must be present in the repository
if [ -f "$PROBLEM_MATCHER_FILE" ]; then # checkout (outside the Docker container running hadolint). We create
cp "$PROBLEM_MATCHER_FILE" "$HOME/" # a temporary folder and copy problem-matcher.json to it and make it
fi # readable.
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.
# shellcheck disable=SC2317
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::$HOME/problem-matcher.json" echo "::add-matcher::${TMP_FOLDER}/problem-matcher.json"
if [ -n "$HADOLINT_CONFIG" ]; then if [ -n "$HADOLINT_CONFIG" ]; then
HADOLINT_CONFIG="-c ${HADOLINT_CONFIG}" HADOLINT_CONFIG="-c ${HADOLINT_CONFIG}"
fi fi
if [ -z "$HADOLINT_TRUSTED_REGISTRIES" ]; then for i in $HADOLINT_IGNORE; do
unset HADOLINT_TRUSTED_REGISTRIES HADOLINT_IGNORE_CMDLINE="${HADOLINT_IGNORE_CMDLINE} --ignore=${i}"
fi done
COMMAND="hadolint $HADOLINT_CONFIG"
if [ "$HADOLINT_RECURSIVE" = "true" ]; then if [ "$HADOLINT_RECURSIVE" = "true" ]; then
shopt -s globstar shopt -s globstar
filename="${!#}" filename="${!#}"
flags="${*:1:$#-1}" flags="${@:1:$#-1}"
RESULTS=$(eval "$COMMAND $flags" -- **/"$filename") hadolint $HADOLINT_IGNORE_CMDLINE $HADOLINT_CONFIG $flags **/$filename
else else
flags=$* # shellcheck disable=SC2086
RESULTS=$(eval "$COMMAND" "$flags") hadolint $HADOLINT_IGNORE_CMDLINE $HADOLINT_CONFIG "$@"
fi fi
FAILED=$?
if [ -n "$HADOLINT_OUTPUT" ]; then
if [ -f "$HADOLINT_OUTPUT" ]; then
HADOLINT_OUTPUT="$TMP_FOLDER/$HADOLINT_OUTPUT"
fi
echo "$RESULTS" >"$HADOLINT_OUTPUT"
fi
RESULTS="${RESULTS//$'\\n'/''}"
{
echo "results<<EOF"
echo "$RESULTS"
echo "EOF"
} >>"$GITHUB_OUTPUT"
{
echo "HADOLINT_RESULTS<<EOF"
echo "$RESULTS"
echo "EOF"
} >>"$GITHUB_ENV"
[ -z "$HADOLINT_OUTPUT" ] || echo "Hadolint output saved to: $HADOLINT_OUTPUT"
exit $FAILED