mirror of
https://github.com/hadolint/hadolint-action.git
synced 2025-02-25 16:03:59 +01:00
78 lines
3.7 KiB
Markdown
78 lines
3.7 KiB
Markdown
# Hadolint Action
|
|
|
|
> GitHub Action that runs [Hadolint](https://github.com/hadolint/hadolint) Dockerfile linting tool.
|
|
|
|
[](https://github.com/features/actions)
|
|
[](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
|
|
|
|
Add the following step to your workflow configuration:
|
|
|
|
```yml
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- uses: hadolint/hadolint-action@v1.5.0
|
|
with:
|
|
dockerfile: Dockerfile
|
|
```
|
|
|
|
## Inputs
|
|
|
|
| Name | Description | Default |
|
|
|------------------ |------------------------------------------ |----------------- |
|
|
| dockerfile | The path to the Dockerfile to be tested | ./Dockerfile |
|
|
| format | The output format. One of [tty \| json \| | tty |
|
|
| | checkstyle \| codeclimate \| | |
|
|
| | gitlab_codeclimate] | |
|
|
| ignore | Space separated list of Hadolint rules to | <none> |
|
|
| | ignore. | |
|
|
| config | Custom path to a Hadolint config file | ./.hadolint.yaml |
|
|
| failure-threshold | Rule severity threshold for pipeline | info |
|
|
| | failure. One of [error \| warning \| | |
|
|
| | info \| style \| ignore] | |
|
|
|
|
## 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).
|
|
|
|
|
|
## 🤝 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
|
|
|
|
## 💛 Support the project
|
|
|
|
If this project was useful to you in some form, I would be glad to have your support. It will help to keep the project alive and to have more time to work on Open Source.
|
|
|
|
The sinplest form of support is to give a ⭐️ to this repo.
|
|
|
|
You can also contribute with [GitHub Sponsors](https://github.com/sponsors/brpaz).
|
|
|
|
[](https://github.com/sponsors/brpaz)
|
|
|
|
Or if you prefer a one time donation to the project, you can simple:
|
|
|
|
<a href="https://www.buymeacoffee.com/Z1Bu6asGV" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
|
|
## Author
|
|
|
|
👤 **Bruno Paz**
|
|
|
|
* Website: [https://github.com/brpaz](https://github.com/brpaz)
|
|
* Github: [@brpaz](https://github.com/brpaz)
|
|
|
|
## 📝 License
|
|
|
|
Copyright © 2019 [Bruno Paz](https://github.com/brpaz).
|
|
|
|
This project is [MIT](LICENSE) licensed.
|