Skip to content

Commit

Permalink
[TASK] Re-structure readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
ochorocho committed Sep 9, 2024
1 parent 4c10d00 commit 3265230
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <version, at least major.minor> -p
Expand All @@ -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 |
|-----------------------|--------------------------------|
Expand All @@ -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).

Expand Down

0 comments on commit 3265230

Please sign in to comment.