From 8a428b481548d64b03c26b46529ce1da982d6aff Mon Sep 17 00:00:00 2001 From: Mike Nye Date: Fri, 25 Mar 2022 13:07:15 +0800 Subject: [PATCH] prettify readme --- README.md | 45 +++++++++++++++++---------------------------- 1 file changed, 17 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 57d4a3e..a882421 100644 --- a/README.md +++ b/README.md @@ -23,34 +23,23 @@ steps: ## 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 | | -| | ignore. | | -| trusted-registries | List of urls of trusted registries | | +| Name | Description | Default | +|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| `dockerfile` | The path to the Dockerfile to be tested | `./Dockerfile` | +| `recursive` | Search for specified dockerfile
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
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` \|
`checkstyle` \| `codeclimate` \|
`gitlab_codeclimate` \| `codacy` \| `sarif`] | `tty` | +| `failure-threshold` | Rule severity threshold for pipeline
failure. One of [`error` \| `warning` \|
`info` \| `style` \| `ignore`] | `info` | +| `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` | Comma separated list of Hadolint rules to ignore. | | +| `trusted-registries` | List of urls of trusted registries | | ## Hadolint Configuration