Initial draft of plugin.
All checks were successful
All checks were successful
This commit is contained in:
parent
0511d55c7d
commit
7c735d4874
16 changed files with 717 additions and 0 deletions
73
README.md
Normal file
73
README.md
Normal file
|
@ -0,0 +1,73 @@
|
|||
# Hadolint WoodpeckerCI Plugin
|
||||
|
||||
[](https://hub.docker.com/r/kokuwaio/hadolint)
|
||||
[](https://hub.docker.com/r/kokuwaio/hadolint)
|
||||
[](https://git.kokuwa.io/woodpecker/hadolint/src/branch/main/Dockerfile)
|
||||
[](https://git.kokuwa.io/woodpecker/hadolint/src/branch/main/LICENSE)
|
||||
[](https://git.kokuwa.io/woodpecker/hadolint/pulls)
|
||||
[](https://git.kokuwa.io/woodpecker/hadolint/issues)
|
||||
|
||||
A [WoodpeckerCI](https://woodpecker-ci.org) plugin for [hadolint](https://github.com/hadolint/hadolint) to lint Dockerfiles.
|
||||
Also usable with Gitlab, Github or locally, see examples for usage.
|
||||
|
||||
## Features
|
||||
|
||||
- preconfigure hadolint parameters
|
||||
- searches for Dockerfiles recursive
|
||||
- runnable with local docker daemon
|
||||
|
||||
## Example
|
||||
|
||||
Woodpecker:
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
hadolint:
|
||||
image: kokuwaio/hadolint
|
||||
settings:
|
||||
strict-labels: true
|
||||
format: json
|
||||
when:
|
||||
event: pull_request
|
||||
path: [.hadolint.yaml, "**/Dockerfile"]
|
||||
```
|
||||
|
||||
Gitlab:
|
||||
|
||||
```yaml
|
||||
hadolint:
|
||||
stage: lint
|
||||
image: kokuwaio/hadolint
|
||||
variables:
|
||||
PLUGIN_STRICT_LABELS: true
|
||||
PLUGIN_FORMAT: json
|
||||
rules:
|
||||
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
|
||||
changes: [.hadolint.yaml, "**/Dockerfile"]
|
||||
```
|
||||
|
||||
CLI:
|
||||
|
||||
```bash
|
||||
docker run --rm --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/hadolint --strict-labels --format=json
|
||||
```
|
||||
|
||||
## Settings
|
||||
|
||||
| Settings Name | Environment | Default | Description |
|
||||
| ----------------------- | ---------------------------- | ------- | --------------------------------------------------------------- |
|
||||
| `no-fail` | PLUGIN_NO_FAIL | `none` | Don't exit with a failure status code when any rule is violated |
|
||||
| `no-color` | PLUGIN_NO_COLOR | `none` | Don't colorize output |
|
||||
| `strict-labels` | PLUGIN_STRICT_LABELS | `none` | Do not permit labels other than specified in `label-schema` |
|
||||
| `disable-ignore-pragma` | PLUGIN_DISABLE_IGNORE_PRAGMA | `none` | Disable inline ignore pragmas `# hadolint ignore=DLxxxx` |
|
||||
| `failure-threshold` | PLUGIN_FAILURE_THRESHOLD | `style` | Exit with failure code only when rules with a severity equal to or above THRESHOLD are violated. Accepted values: error, warning, info, style, ignore, none |
|
||||
| `format` | PLUGIN_FORMAT | `tty` | The output format for the results: tty, json, checkstyle, codeclimate, gitlab_codeclimate, gnu, codacy, sonarqube, sarif |
|
||||
| `verbose` | PLUGIN_VERBOSE | `false` | Enables verbose logging of hadolint's output to stderr |
|
||||
|
||||
## Alternatives
|
||||
|
||||
| Image | Comment | amd64 | arm64 |
|
||||
| ----------------------------------------------------------------------------------- | --------------------------------- |:-----:|:-----:|
|
||||
| [kokuwaio/hadolint](https://hub.docker.com/r/kokuwaio/hadolint) | Woodpecker plugin | [](https://hub.docker.com/r/kokuwaio/hadolint) | [](https://hub.docker.com/r/kokuwaio/hadolint) |
|
||||
| [hadolint/hadolint](https://hub.docker.com/r/hadolint/hadolint) | not a Woodpecker plugin, official | [](https://hub.docker.com/r/hadolint/hadolint) | [](https://hub.docker.com/r/hadolint/hadolint) |
|
||||
| [pipelinecomponents/hadolint](https://hub.docker.com/r/pipelinecomponents/hadolint) | not a Woodpecker plugin | [](https://hub.docker.com/r/pipelinecomponents/hadolint) | [](https://hub.docker.com/r/pipelinecomponents/hadolint) |
|
Loading…
Add table
Add a link
Reference in a new issue