2020-12-06 09:46:26 +00:00
# Hadolint Action
2019-10-02 21:50:00 +01:00
2020-12-06 09:46:26 +00:00
> GitHub Action that runs [Hadolint](https://github.com/hadolint/hadolint) Dockerfile linting tool.
2019-10-02 21:50:00 +01:00
[](https://github.com/features/actions)
[](LICENSE)
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/semantic-release/semantic-release?style=for-the-badge)
2021-04-14 19:25:02 +01:00
[](https://github.com/hadolint/hadolint-action/action)
2019-10-02 21:50:00 +01:00
## Usage
2020-12-06 09:46:26 +00:00
Add the following step to your workflow configuration:
2019-10-02 21:50:00 +01:00
```yml
steps:
2021-05-10 11:31:03 +02:00
- uses: actions/checkout@v2
2021-10-19 15:49:02 +02:00
- uses: hadolint/hadolint-action@v1 .6.0
2021-05-08 13:08:16 +02:00
with:
dockerfile: Dockerfile
2019-10-02 21:50:00 +01:00
```
## Inputs
2021-11-18 13:09:22 +01:00
| 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. | |
2022-03-22 11:40:08 +01:00
| trusted-registries | List of urls of trusted registries | |
2020-12-06 09:46:26 +00:00
## Hadolint Configuration
To configure Hadolint (for example ignore rules), you can create an `.hadolint.yaml` file in the root of your repository. Please check the Hadolint [documentation ](https://github.com/hadolint/hadolint#configure ).
2019-10-02 21:50:00 +01:00
## 🤝 Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated** .
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature` )
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
2022-03-22 11:44:03 +01:00
2020-12-06 09:46:26 +00:00
## 💛 Support the project
2021-05-17 19:06:18 +01:00
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.
2020-12-06 09:46:26 +00:00
The sinplest form of support is to give a ⭐️ to this repo.
2021-05-17 19:06:18 +01:00
This project was originally created by [Bruno Paz ](https://github.com/sponsors/brpaz ) and incorporated into the Hadolint organization. If you appreciate the work done on this action, Bruno would be happy with your [sponsorship ](https://github.com/sponsors/brpaz ).
2020-12-06 09:46:26 +00:00
2019-10-02 21:50:00 +01:00
## Author
👤 **Bruno Paz**
* Website: [https://github.com/brpaz ](https://github.com/brpaz )
* Github: [@brpaz ](https://github.com/brpaz )
## 📝 License
2021-05-17 19:06:18 +01:00
[MIT ](LICENSE )