docs(get-images-from-files): document compose support (#28)
CD / Release (push) Successful in 5s
CD / Release (push) Successful in 5s
get-images-from-files already supports compose files. This PR explicitly documents the compatibility and includes a test. Reviewed-on: t.behrendt/trivy-actions#28 Reviewed-by: branch-buddy <branch-buddy@t00n.de> Co-authored-by: t.behrendt <t.behrendt@t00n.de> Co-committed-by: t.behrendt <t.behrendt@t00n.de>
This commit was merged in pull request #28.
This commit is contained in:
@@ -44,6 +44,7 @@ jobs:
|
|||||||
files: |
|
files: |
|
||||||
- get-images-from-files/test.Dockerfile
|
- get-images-from-files/test.Dockerfile
|
||||||
- get-images-from-files/test-deployment.yaml
|
- get-images-from-files/test-deployment.yaml
|
||||||
|
- get-images-from-files/test-compose.yaml
|
||||||
- name: Check image formats extracted
|
- name: Check image formats extracted
|
||||||
run: |
|
run: |
|
||||||
images="${{ steps.giff.outputs.images }}"
|
images="${{ steps.giff.outputs.images }}"
|
||||||
@@ -59,6 +60,10 @@ jobs:
|
|||||||
check "K8s registry+tag (app:v2)" "example.com/library/app:v2"
|
check "K8s registry+tag (app:v2)" "example.com/library/app:v2"
|
||||||
check "K8s registry+digest (helper@sha256:...)" "example.com/myproject/helper@sha256:bbbbbbbb"
|
check "K8s registry+digest (helper@sha256:...)" "example.com/myproject/helper@sha256:bbbbbbbb"
|
||||||
|
|
||||||
|
# Compose-only refs
|
||||||
|
check "Compose registry+tag (web:v3)" "example.com/compose/web:v3"
|
||||||
|
check "Compose registry+tag (worker:v3)" "example.com/compose/worker:v3"
|
||||||
|
|
||||||
# Shared ref (in both files) — must appear exactly once
|
# Shared ref (in both files) — must appear exactly once
|
||||||
check "Shared ref present (distroless/static:nonroot)" "example.com/distroless/static:nonroot"
|
check "Shared ref present (distroless/static:nonroot)" "example.com/distroless/static:nonroot"
|
||||||
count=$(echo "$images" | tr ',' '\n' | grep -c 'example.com/distroless/static:nonroot' || true)
|
count=$(echo "$images" | tr ',' '\n' | grep -c 'example.com/distroless/static:nonroot' || true)
|
||||||
@@ -66,7 +71,7 @@ jobs:
|
|||||||
[ "$count" -eq 1 ] && echo "OK (count=$count)" || { echo "FAIL (count=$count, expected 1)"; exit 1; }
|
[ "$count" -eq 1 ] && echo "OK (count=$count)" || { echo "FAIL (count=$count, expected 1)"; exit 1; }
|
||||||
total=$(echo "$images" | tr ',' '\n' | grep -c . || true)
|
total=$(echo "$images" | tr ',' '\n' | grep -c . || true)
|
||||||
echo -n " Total unique refs: "
|
echo -n " Total unique refs: "
|
||||||
[ "$total" -eq 5 ] && echo "OK ($total)" || { echo "FAIL (got $total, expected 5)"; exit 1; }
|
[ "$total" -eq 7 ] && echo "OK ($total)" || { echo "FAIL (got $total, expected 7)"; exit 1; }
|
||||||
|
|
||||||
echo ""
|
echo ""
|
||||||
echo "All checks passed."
|
echo "All checks passed."
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
A reusable Gitea Action, that extracts docker images from selected files in a repository.
|
A reusable Gitea Action, that extracts docker images from selected files in a repository.
|
||||||
|
|
||||||
The action supports Dockerfiles and Kubernetes manifests. Other files are supported if they have a recognizable image reference. Duplicate image references are deduplicated.
|
The action supports Dockerfiles, Kubernetes manifests, and Docker Compose/compose files. Other files are supported if they have a recognizable image reference. Duplicate image references are deduplicated.
|
||||||
|
|
||||||
**Note:** Only fully-qualified refs (with registry, e.g. `docker.io/library/alpine:latest`, `gcr.io/distroless/static:nonroot@sha256:...`) are included; short refs like `alpine:latest` are omitted as their use is discouraged.
|
**Note:** Only fully-qualified refs (with registry, e.g. `docker.io/library/alpine:latest`, `gcr.io/distroless/static:nonroot@sha256:...`) are included; short refs like `alpine:latest` are omitted as their use is discouraged.
|
||||||
|
|
||||||
@@ -17,6 +17,7 @@ The action supports Dockerfiles and Kubernetes manifests. Other files are suppor
|
|||||||
files: |
|
files: |
|
||||||
- Dockerfile
|
- Dockerfile
|
||||||
- k8s/50_deployment.yaml
|
- k8s/50_deployment.yaml
|
||||||
|
- dockers/compose.yaml
|
||||||
- values/traefik.yaml
|
- values/traefik.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -37,6 +38,7 @@ jobs:
|
|||||||
files: |
|
files: |
|
||||||
- Dockerfile
|
- Dockerfile
|
||||||
- k8s/50_deployment.yaml
|
- k8s/50_deployment.yaml
|
||||||
|
- dockers/compose.yaml
|
||||||
- values/traefik.yaml
|
- values/traefik.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
name: "Get Images From Files"
|
name: "Get Images From Files"
|
||||||
description: "Extract docker images from selected files (Dockerfiles, Kubernetes manifests, and files with recognizable image references)"
|
description: "Extract docker images from selected files (Dockerfiles, Kubernetes manifests, Docker Compose/compose files, and files with recognizable image references)"
|
||||||
author: "Timo Behrendt <t.behrendt@t00n.de>"
|
author: "Timo Behrendt <t.behrendt@t00n.de>"
|
||||||
branding:
|
branding:
|
||||||
icon: "package"
|
icon: "package"
|
||||||
@@ -30,7 +30,7 @@ runs:
|
|||||||
[ -f "$f" ] || continue
|
[ -f "$f" ] || continue
|
||||||
# Dockerfile: FROM [--platform=...] <image>
|
# Dockerfile: FROM [--platform=...] <image>
|
||||||
awk '/^[[:space:]]*FROM[[:space:]]/ { print $NF }' "$f" 2>/dev/null || true
|
awk '/^[[:space:]]*FROM[[:space:]]/ { print $NF }' "$f" 2>/dev/null || true
|
||||||
# Kubernetes / Compose: image: <ref>
|
# Kubernetes / Docker Compose: image: <ref>
|
||||||
grep -E '[[:space:]]image:[[:space:]]' "$f" 2>/dev/null | sed 's/.*image:[[:space:]]*//' | awk '{ print $1 }' || true
|
grep -E '[[:space:]]image:[[:space:]]' "$f" 2>/dev/null | sed 's/.*image:[[:space:]]*//' | awk '{ print $1 }' || true
|
||||||
done | grep -E '/' | sort -u | paste -sd,
|
done | grep -E '/' | sort -u | paste -sd,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -0,0 +1,6 @@
|
|||||||
|
# Used by CI to test get-images-from-files action (Docker Compose, registry refs only)
|
||||||
|
services:
|
||||||
|
web:
|
||||||
|
image: example.com/compose/web:v3
|
||||||
|
worker:
|
||||||
|
image: example.com/compose/worker:v3
|
||||||
Reference in New Issue
Block a user