Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/reviewdog/action-hadolint

Run hadolint with reviewdog 🐶
https://github.com/reviewdog/action-hadolint

github-actions hacktoberfest hadolint reviewdog

Last synced: 30 days ago
JSON representation

Run hadolint with reviewdog 🐶

Host: GitHub
URL: https://github.com/reviewdog/action-hadolint
Owner: reviewdog
License: mit
Created: 2019-12-06T19:05:40.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-10-07T18:29:27.000Z (2 months ago)
Last Synced: 2024-10-14T20:01:54.518Z (about 2 months ago)
Topics: github-actions, hacktoberfest, hadolint, reviewdog
Language: Shell
Homepage:
Size: 8.61 MB
Stars: 48
Watchers: 30
Forks: 16
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

stars - reviewdog/action-hadolint - Run hadolint with reviewdog 🐶 \[*MIT License*\] (⭐️50) (Shell)
stars - reviewdog/action-hadolint - Run hadolint with reviewdog 🐶 \[*MIT License*\] (⭐️49) (Shell)

README

# GitHub Action: Run hadolint with reviewdog 🐶

[![](https://img.shields.io/github/license/reviewdog/action-hadolint)](./LICENSE)
[![depup](https://github.com/reviewdog/action-hadolint/workflows/depup/badge.svg)](https://github.com/reviewdog/action-hadolint/actions?query=workflow%3Adepup)
[![release](https://github.com/reviewdog/action-hadolint/workflows/release/badge.svg)](https://github.com/reviewdog/action-hadolint/actions?query=workflow%3Arelease)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/reviewdog/action-hadolint?logo=github&sort=semver)](https://github.com/reviewdog/action-hadolint/releases)
[![action-bumpr supported](https://img.shields.io/badge/bumpr-supported-ff69b4?logo=github&link=https://github.com/haya14busa/action-bumpr)](https://github.com/haya14busa/action-bumpr)

This action runs [hadolint](https://github.com/hadolint/hadolint) with
[reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to lint Dockerfile
and validate inline bash.

## Examples

### With `github-pr-check`

By default, with `reporter: github-pr-check` an annotation is added to the line:

![Example comment made by the action, with github-pr-check](./examples/example-github-pr-check.png)

### With `github-pr-review`

With `reporter: github-pr-review` a comment is added to the Pull Request Conversation:

![Example comment made by the action, with github-pr-review](examples/example-github-pr-review.png)

## Inputs

### `github_token`

Optional. `${{ github.token }}` is used by default.

### `hadolint_flags`

Optional. Pass hadolint flags:
```
with:
hadolint_flags: --trusted-registry docker.io
```

### `hadolint_ignore`

Optional. Pass hadolint rules to ignore them:
```
with:
hadolint_ignore: DL3009 DL3008
```

### `tool_name`

Optional. Tool name to use for reviewdog reporter. Useful when running multiple
actions with different config.

### `exclude`

Optional. List of folders and files to exclude from checking.

Use `/%FOLDER%/*` to exclude whole folder or `%FILENAME%` to exclude certain files.

Note that you can use wildcard to exclude certain file extensions, like `Dockerfile.*` will exclude `Dockerfile.dev`, but will not exclude `Dockerfile`.

You can combine those rules as you wish (i.e. exclude certain files from certain folders only):
```yaml
with:
exclude: |
/vendor/*
Dockerfile.*
```

### `level`

Optional. Report level for reviewdog [`info`, `warning`, `error`].
It's same as `-level` flag of reviewdog.

### `reporter`

Optional. Reporter of reviewdog command [`github-pr-check`, `github-pr-review`].
The default is `github-pr-check`.

### `filter_mode`

Optional. Filtering mode for the reviewdog command [`added`, `diff_context`, `file`, `nofilter`].
Default is `added`.

### `fail_on_error`

Optional. Exit code for reviewdog when errors are found [`true`, `false`]
Default is `false`.

### `reviewdog_flags`

Optional. Additional reviewdog flags.

## Example usage

```yml
name: reviewdog
on: [pull_request]
jobs:
hadolint:
name: runner / hadolint
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v4
- name: hadolint
uses: reviewdog/action-hadolint@v1
with:
reporter: github-pr-review # Default is github-pr-check
```

## Sponsor

## License

[MIT](https://choosealicense.com/licenses/mit)