From 6b5d5a82833ab7cc7a43e3ae5be1f25ef31ddba4 Mon Sep 17 00:00:00 2001 From: Rafael Bradley Date: Sat, 15 Mar 2025 11:57:45 -0300 Subject: [PATCH] docs: :memo: Add docs on how to add new images. --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 505f16c..17fa768 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,18 @@ This repository contains a series of prebuilt images to help you skip some build ## Images -- `repository.nyeki.dev/docker/python/with-uv:3.13.2-alpine`: Python 3.13.2 Alpine with UV preinstalled. +- `repository.nyeki.dev/docker/python/with-uv:3.13.2-alpine`: Python 3.13.2 Alpine with UV + preinstalled. +- `repository.nyeki.dev/docker/python/with-uv:3.12-alpine`: Python 3.12 Alpine with UV + preinstalled. + +## Adding a New Image + +TO create a new image, follow these steps: + +1. Check whether an image and tag of what you want to add already exists in `./dockerfiles`. If + there is, modify it in case you need to. +2. If there's no image of what you want to build, create the Dockerfiles using the + `./dockerfiles/{image}/{tag}/Dockerfile` template. Check other images for examples. +3. From the root directory of the repository, run `uv sync && uv run scripts/push.py`. +4. Follow the steps that are outputted into your console.