Give test-ubuntu-git its own README (#1620)

* Give `test-ubuntu-git` its own `README` * Refined title and description in `test-ubuntu-git.Dockerfile` * nit accepted: Remove double space --------- Co-authored-by: Ferenc Hammerl <[email protected]>
actions · Feb 22, 2024 · 2650dbd · 2650dbd
1 parent aadec89
commit 2650dbd
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/images/test-ubuntu-git.Dockerfile b/images/test-ubuntu-git.Dockerfile
@@ -6,5 +6,7 @@ FROM ubuntu:latest
 RUN apt update
 RUN apt install -y git
 
-LABEL org.opencontainers.image.description="Ubuntu image with git pre-installed"
+LABEL org.opencontainers.image.title="Ubuntu + git (validation image)"
+LABEL org.opencontainers.image.description="Ubuntu image with git pre-installed. Intended primarily for testing `actions/checkout` during CI/CD workflows."
+LABEL org.opencontainers.image.documentation="https://github.com/actions/checkout/tree/main/images/test-ubuntu-git.md"
 LABEL org.opencontainers.image.licenses=MIT
diff --git a/images/test-ubuntu-git.md b/images/test-ubuntu-git.md
@@ -0,0 +1,15 @@
+# `test-ubuntu-git` Container Image
+
+[![Publish test-ubuntu-git Container](https://github.com/actions/checkout/actions/workflows/update-test-ubuntu-git.yml/badge.svg)](https://github.com/actions/checkout/actions/workflows/update-test-ubuntu-git.yml)
+
+## Purpose
+
+`test-ubuntu-git` is a container image hosted on the GitHub Container Registry, `ghcr.io`.  
+
+It is intended primarily for testing the [`actions/checkout` repository](https://github.com/actions/checkout) as part of `actions/checkout`'s CI/CD workflows.
+
+The composition of `test-ubuntu-git` is intentionally minimal.  It is comprised of [git](https://git-scm.com/) installed on top of a [base-level ubuntu image](https://hub.docker.com/_/ubuntu/tags).
+
+# License
+
+`test-ubuntu-git` is released under the [MIT License](/LICENSE).