Skip to content

Commit d620bdb

Browse files
docs: update readme
1 parent 94003f8 commit d620bdb

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

docker-build/README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,18 @@ This reusable GitHub Actions workflow automates the process of building and push
1717

1818
## ⚙️ Inputs
1919

20-
| Name | Description | Required | Default |
21-
| ----------------- | ---------------------------------------------------------------------------------- | -------- | -------------- |
22-
| `image-name` | Name of Docker Image (e.g., 'myimage', 'myorg/myimage') | true | - |
23-
| `image-tag` | Tag to apply to the built image (e.g., 'latest', 'v1.2.3') | No | `"latest"` |
24-
| `dockerfile` | Path to the Dockerfile to build (e.g., './Dockerfile', './docker/Dockerfile') | No | `"Dockerfile"` |
25-
| `context` | Path to Docker Build Context | No | `"."` |
26-
| `registry` | Docker Registry | No | `"docker.io"` |
27-
| `push` | Push Docker Image to Registry | No | `false` |
28-
| `security-scan` | Enable Trivy Security Scan | No | `true` |
29-
| `security-report` | Security Report Mode (`"sarif"` \| `"comment"`; ignored if `security-scan: false`) | No | `"sarif"` |
30-
| `hadolint` | Enable Hadolint | No | `true` |
20+
| Name | Description | Required | Default |
21+
| ----------------- | ---------------------------------------------------------------------------------- | -------- | --------------------------- |
22+
| `image-name` | Name of Docker Image (e.g., 'myimage', 'myorg/myimage') | true | - |
23+
| `image-tag` | Tag to apply to the built image (e.g., 'latest', 'v1.2.3') | No | `"latest"` |
24+
| `dockerfile` | Path to the Dockerfile to build (e.g., './Dockerfile', './docker/Dockerfile') | No | `"Dockerfile"` |
25+
| `context` | Path to Docker Build Context | No | `"."` |
26+
| `platforms` | Indicates which platforms the image should be built for | No | `"linux/amd64,linux/arm64"` |
27+
| `registry` | Docker Registry | No | `"docker.io"` |
28+
| `push` | Push Docker Image to Registry | No | `false` |
29+
| `security-scan` | Enable Trivy Security Scan | No | `true` |
30+
| `security-report` | Security Report Mode (`"sarif"` \| `"comment"`; ignored if `security-scan: false`) | No | `"sarif"` |
31+
| `hadolint` | Enable Hadolint | No | `true` |
3132

3233
## 🔐 Secrets
3334

0 commit comments

Comments
 (0)