actions/hadolint-action
1
0
Fork 0
mirror of https://github.com/hadolint/hadolint-action.git synced 2026-07-19 05:39:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

more info for inputs

Browse Source
This commit is contained in:
Mike Nye
2022-03-25 13:09:48 +08:00
parent 8a428b4815
commit 89e60e4868
1 changed files with 8 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -9
View File
@@ -6,7 +6,6 @@
[![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/workflow/status/hadolint/hadolint-action/CI?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
@@ -29,17 +28,17 @@ steps:
| `recursive` | Search for specified dockerfile </br> recursively, from the project root | `false` | | `recursive` | Search for specified dockerfile </br> recursively, from the project root | `false` |
| `config` | Custom path to a Hadolint config file | `./.hadolint.yaml` | | `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 | | | `output-file` | A sub-path where to save the </br> output as a file to | |
| `no-color` | Don't create colored output | | | `no-color` | Don't create colored output (`true`/`false`) | |
| `no-fail` | Never fail the action | | | `no-fail` | Never fail the action (`true`/`false`) | |
| `verbose` | Output more information | | | `verbose` | Output more information (`true`/`false`) | |
| `format` | The output format. One of [`tty` \| `json` \| </br> `checkstyle` \| `codeclimate` \| </br> `gitlab_codeclimate` \| `codacy` \| `sarif`] | `tty` | | `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` | | `failure-threshold` | Rule severity threshold for pipeline </br> failure. One of [`error` \| `warning` \| </br> `info` \| `style` \| `ignore`] | `info` |
| `override-error` | List of rules to treat with `error` severity | | | `override-error` | Comma separated list of rules to treat with `error` severity | |
| `override-warning` | List of rules to treat with `warning` severity | | | `override-warning` | Comma separated list of rules to treat with `warning` severity | |
| `override-info` | List of rules to treat with `info` severity | | | `override-info` | Comma separated list of rules to treat with `info` severity | |
| `override-style` | List of rules to treat with `style` severity | | | `override-style` | Comma separated list of rules to treat with `style` severity | |
| `ignore` | Comma separated list of Hadolint rules to ignore. | <none> | | `ignore` | Comma separated list of Hadolint rules to ignore. | <none> |
| `trusted-registries` | List of urls of trusted registries | | | `trusted-registries` | Comma separated list of urls of trusted registries | |
## Hadolint Configuration ## Hadolint Configuration