From 8ed8e7304c4776ea28aafb9a3760b7843ffb4f27 Mon Sep 17 00:00:00 2001 From: "t.behrendt" Date: Thu, 5 Feb 2026 15:48:30 +0100 Subject: [PATCH] docs: better list supported formats --- get-images-from-files/README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/get-images-from-files/README.md b/get-images-from-files/README.md index 35ef8ba..b267087 100644 --- a/get-images-from-files/README.md +++ b/get-images-from-files/README.md @@ -1,11 +1,20 @@ # Get Images From Files Action -A reusable Gitea Action, that extracts docker images from selected files in a repository. - -The action supports Dockerfiles, Kubernetes manifests, Docker Compose/compose files, and Helmfile value files (convention: `repository` required, `tag` optional; a lone `tag` without `repository` is skipped). Other files are supported if they have a recognizable image reference. Duplicate image references are deduplicated. +A reusable Gitea Action that extracts Docker image references from selected files in a repository. Duplicate refs 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. +## Supported file formats + +| Format | How images are extracted | +| ------ | ------------------------- | +| **Dockerfile** | `FROM` lines; the image ref is the last token (handles `FROM --platform=... `). | +| **Kubernetes manifests** | Lines with `image:` (e.g. under `containers` / `initContainers`); the value is taken as the image ref. | +| **Docker Compose / Compose** | Same as Kubernetes: `image:` key under services. | +| **Helmfile values** | Pairs of `repository` and optional `tag` at the same indent; ref is `repository` or `repository:tag`. A lone `tag` without `repository` is skipped. | + +Other files are supported if they use one of these patterns (e.g. `image:` or `FROM`). + ## Usage ### Basic Usage