mirror of
https://github.com/hadolint/hadolint-action.git
synced 2026-07-06 08:31:42 +00:00
Compare commits
31 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 José Lorenzo Rodríguez
|
f988afea3d | ||
|
Harm Weites
|
55991004e8 | ||
|
Harm Weites
|
d73282b64c | ||
|
Harm Weites
|
2faf5c6ef4 | ||
|
Harm Weites
|
724e05f46b | ||
|
Harm Weites
|
a78be8d386 | ||
|
Harm Weites
|
652bc66203 | ||
|
Harm Weites
|
1dd44fc493 | ||
|
Harm Weites
|
5fc1b0e2fb | ||
|
Harm Weites
|
a8bbf351c0 | ||
|
Harm Weites
|
e3462c378d | ||
|
Harm Weites
|
0c7fcaa67b | ||
|
Harm Weites
|
8ea032569b | ||
|
Harm Weites
|
262f403978 | ||
|
Harm Weites
|
1878581f63 | ||
|
Harm Weites
|
bc289f2eaa | ||
|
José Lorenzo Rodríguez
|
83b3de1e17 | ||
|
José Lorenzo Rodríguez
|
289302ad8f | ||
|
Mike Nye
|
89e60e4868 | ||
|
Mike Nye
|
8a428b4815 | ||
|
José Lorenzo Rodríguez
|
0a6d062e78 | ||
|
José Lorenzo Rodríguez
|
0b08ca228d | ||
|
José Lorenzo Rodríguez
|
9a555bc2d4 | ||
|
José Lorenzo Rodríguez
|
e8cde77aa0 | ||
|
José Lorenzo Rodríguez
|
bc86787e19 | ||
|
José Lorenzo Rodríguez
|
d2b4ab26ff | ||
|
José Lorenzo Rodríguez
|
2bcb99c6e2 | ||
|
Paul Barton
|
63666e594d | ||
|
José Lorenzo Rodríguez
|
96339c1113 | ||
|
offa
|
37f399667b | ||
|
offa
|
aa70df94a2 |
@@ -71,18 +71,23 @@ jobs:
|
||||
|
||||
- name: Run integration test 5 - output format
|
||||
# This step will never fail, but will print out rule violations.
|
||||
id: hadolint5
|
||||
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
|
||||
- name: Run integration test 6 - verify results output parameter
|
||||
# This step will never fail, but will print out the results from step5
|
||||
run: echo "${{ steps.hadolint5.outputs.results }}"
|
||||
|
||||
#- 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'
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
FROM hadolint/hadolint:v2.9.2-debian
|
||||
FROM hadolint/hadolint:v2.9.3-debian
|
||||
|
||||
COPY LICENSE README.md problem-matcher.json /
|
||||
COPY hadolint.sh /usr/local/bin/hadolint.sh
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
IMAGE_NAME:=hadolint-action
|
||||
|
||||
lint-dockerfile: ## Runs hadoint against application dockerfile
|
||||
lint-dockerfile: ## Runs hadolint against application dockerfile
|
||||
@docker run --rm -v "$(PWD):/data" -w "/data" hadolint/hadolint hadolint Dockerfile
|
||||
|
||||
lint-yaml: ## Lints yaml configurations
|
||||
@@ -12,8 +12,8 @@ build: ## Builds the docker image
|
||||
|
||||
test: build ## Runs a test in the image
|
||||
@docker run -i --rm \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
-v ${PWD}:/test zemanlx/container-structure-test:v1.8.0-alpine \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
-v ${PWD}:/test zemanlx/container-structure-test:v1.8.0-alpine \
|
||||
test \
|
||||
--image $(IMAGE_NAME) \
|
||||
--config test/structure-tests.yaml
|
||||
|
||||
@@ -6,7 +6,6 @@
|
||||
[](LICENSE)
|
||||
[](http://commitizen.github.io/cz-cli/)
|
||||
[](https://github.com/semantic-release/semantic-release?style=for-the-badge)
|
||||
|
||||
[](https://github.com/hadolint/hadolint-action/action)
|
||||
|
||||
## Usage
|
||||
@@ -16,41 +15,57 @@ Add the following step to your workflow configuration:
|
||||
```yml
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: hadolint/hadolint-action@v1.6.0
|
||||
- uses: hadolint/hadolint-action@v2.0.0
|
||||
with:
|
||||
dockerfile: Dockerfile
|
||||
```
|
||||
|
||||
## Inputs
|
||||
|
||||
| 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 | |
|
||||
| Name | Description | Default |
|
||||
|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------|--------------------|
|
||||
| `dockerfile` | The path to the Dockerfile to be tested | `./Dockerfile` |
|
||||
| `recursive` | Search for specified dockerfile </br> recursively, from the project root | `false` |
|
||||
| `config` | Custom path to a Hadolint config file | `./.hadolint.yaml` |
|
||||
| `output-file` | A sub-path where to save the </br> output as a file to | |
|
||||
| `no-color` | Don't create colored output (`true`/`false`) | |
|
||||
| `no-fail` | Never fail the action (`true`/`false`) | |
|
||||
| `verbose` | Output more information (`true`/`false`) | |
|
||||
| `format` | The output format. One of [`tty` \| `json` \| </br> `checkstyle` \| `codeclimate` \| </br> `gitlab_codeclimate` \| `codacy` \| `sarif`] | `tty` |
|
||||
| `failure-threshold` | Rule severity threshold for pipeline </br> failure. One of [`error` \| `warning` \| </br> `info` \| `style` \| `ignore`] | `info` |
|
||||
| `override-error` | Comma separated list of rules to treat with `error` severity | |
|
||||
| `override-warning` | Comma separated list of rules to treat with `warning` severity | |
|
||||
| `override-info` | Comma separated list of rules to treat with `info` severity | |
|
||||
| `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
|
||||
|
||||
@@ -65,6 +80,7 @@ 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, We would be glad to have your support. It will help keeping the project alive.
|
||||
|
||||
+19
-8
@@ -19,12 +19,8 @@ if [ -n "$HADOLINT_CONFIG" ]; then
|
||||
HADOLINT_CONFIG="-c ${HADOLINT_CONFIG}"
|
||||
fi
|
||||
|
||||
OUTPUT=
|
||||
if [ -n "$HADOLINT_OUTPUT" ]; then
|
||||
if [ -f "$HADOLINT_OUTPUT" ]; then
|
||||
HADOLINT_OUTPUT="$TMP_FOLDER/$HADOLINT_OUTPUT"
|
||||
fi
|
||||
OUTPUT=" | tee $HADOLINT_OUTPUT"
|
||||
if [ -z "$HADOLINT_TRUSTED_REGISTRIES" ]; then
|
||||
unset HADOLINT_TRUSTED_REGISTRIES;
|
||||
fi
|
||||
|
||||
if [ "$HADOLINT_RECURSIVE" = "true" ]; then
|
||||
@@ -33,10 +29,25 @@ if [ "$HADOLINT_RECURSIVE" = "true" ]; then
|
||||
filename="${!#}"
|
||||
flags="${@:1:$#-1}"
|
||||
|
||||
hadolint $HADOLINT_CONFIG $flags **/$filename $OUTPUT
|
||||
RESULTS=$(hadolint $HADOLINT_CONFIG $flags **/$filename)
|
||||
else
|
||||
# shellcheck disable=SC2086
|
||||
hadolint $HADOLINT_CONFIG "$@" $OUTPUT
|
||||
RESULTS=$(hadolint $HADOLINT_CONFIG "$@")
|
||||
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 "::set-output name=results::$RESULTS"
|
||||
|
||||
{ echo "HADOLINT_RESULTS<<EOF"; echo "$RESULTS"; echo "EOF"; } >> $GITHUB_ENV
|
||||
|
||||
[ -z "$HADOLINT_OUTPUT" ] || echo "Hadolint output saved to: $HADOLINT_OUTPUT"
|
||||
|
||||
exit $FAILED
|
||||
|
||||
Reference in New Issue
Block a user