Skip to content

GitHub action for Hadolint, A Dockerfile linting tool

License

Notifications You must be signed in to change notification settings

brpaz/hadolint-action

 
 

Repository files navigation

Hadolint Action

GitHub Action that runs Hadolint Dockerfile linting tool.

GitHub Action License Commitizen friendly semantic-release

GitHub Workflow Status

Usage

Add the following step to your workflow configuration:

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
checkstyle codeclimate
gitlab_codeclimate]
ignore Space separated list of Hadolint rules to
ignore.
config Custom path to a Hadolint config file ./.hadolint.yaml
failure-threshold Rule severity threshold for pipeline info
failure. One of [error warning
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.

🤝 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.

GitHub Sponsors

Or if you prefer a one time donation to the project, you can simple:

Buy Me A Coffee

Author

👤 Bruno Paz

📝 License

Copyright © 2019 Bruno Paz.

This project is MIT licensed.

About

GitHub action for Hadolint, A Dockerfile linting tool

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 49.0%
  • Makefile 42.3%
  • Dockerfile 8.7%