Skip to content

Commit 3329b0d

Browse files
committed
update README.md
1 parent 70bd61d commit 3329b0d

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,38 @@
1-
# dockle-action
1+
# dockle-action
2+
3+
GitHub Actions for [goodwithtech/dockle](https://github.com/goodwithtech/dockle)
4+
5+
> Dockle - Container Image Linter for Security, Helping build the Best-Practice Docker Image, Easy to start
6+
7+
Dockle helps you:
8+
9+
1. Build Best Practice Docker images
10+
2. Build secure Docker images
11+
- Checkpoints include CIS Benchmarks
12+
13+
14+
# Usage
15+
16+
```yaml
17+
name: check
18+
on:
19+
push:
20+
jobs:
21+
build:
22+
name: Build
23+
runs-on: ubuntu-20.04
24+
steps:
25+
- name: Checkout code
26+
uses: actions/checkout@v2
27+
- name: Build an image from Dockerfile
28+
run: |
29+
docker build -t built-image:scan .
30+
- name: Run dockle
31+
uses: goodwithtech/dockle-action@main
32+
with:
33+
image: 'built-image:scan'
34+
format: 'list'
35+
exit-code: '1'
36+
exit-level: 'warn'
37+
ignore: 'CIS-DI-0001,DKL-DI-0006'
38+
```

0 commit comments

Comments
 (0)