From 3265230cd9469d4006d351becc492354b3cbb17a Mon Sep 17 00:00:00 2001 From: Jochen Date: Mon, 9 Sep 2024 14:14:03 +0200 Subject: [PATCH] [TASK] Re-structure readme file --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index bbb1a2c..7cc35e2 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,25 @@ A container image to run DDEV on any GitLab Runner (hosted/self-hoster). -## Configuration for self-hosted GitLab Runners +## Configuration for GitLab Runners The Runner can run on the two container engines - Docker and Podman. Both container engines work, but the required configuration is slightly different. -### Example configurations for ... +### Example configurations + +Depending on your setup, you want to pick one if the following example configurations. * [gitlab.com](docs%2Fgitlab-com.md) -* [Docker](docs%2Fdocker.md) -* [Podman](docs%2Fpodman.md) +* [Docker](docs%2Fdocker.md) (self-hosted) +* [Podman](docs%2Fpodman.md) (self-hosted) + +## Image build (for contribution only) -# Workflow - Image build +If you want to extend the image, you'll find the instructions +and details below. -Build the image +Build the image: ```bash ./build.sh -v -p @@ -27,7 +32,7 @@ Available options: * p - Push the image (--push) * x - Build multi-arch image (--platform linux/amd64,linux/arm64) -## Version to tags +### Version to tags | Command | Tags to be created | |-----------------------|--------------------------------| @@ -38,7 +43,7 @@ Available options: The image is stored on the [GitHub Package Registry](https://github.com/ochorocho/ddev-gitlab-ci/pkgs/container/ddev-gitlab-ci) -## Run tests locally +### Run tests locally Requires [bats-core](https://bats-core.readthedocs.io/en/stable/installation.html) and [yq](https://github.com/mikefarah/yq/tree/v4.44.2?tab=readme-ov-file#install).