Skip to content

Fix readme #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 23, 2024
Merged

Fix readme #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea33c30
Fix usage
shmokmt Oct 23, 2024
7ce4713
Add badges
shmokmt Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# GitHub Action: Run `docker build --check` with action-docker-build-check

[![](https://img.shields.io/github/license/shmokmt/action-docker-build-check)](./LICENSE)
[![Test](https://github.com/shmokmt/action-docker-build-check/actions/workflows/test.yml/badge.svg)](https://github.com/shmokmt/action-docker-build-check/actions/workflows/test.yml)

This action runs `docker build --check` with reviewdog on pull requests to improve code review experience.

## Examples
Expand All @@ -10,7 +13,13 @@ This action runs `docker build --check` with reviewdog on pull requests to impro

```yaml
name: reviewdog

on: [pull_request]

permissions:
contents: read
pull-requests: write

jobs:
docker-build-check:
name: docker-build-check
Expand Down