CONTRIBUTING.md

Contribution guide

Thanks for your interest in contributing to this project!

As stated in the README, there are a lot of dependencies on these images, so please understand that it can make it complicated on merging your pull request.

We'd love to have your help, but it might be best to explain your intentions first before contributing.

Project dependencies

You must have these installed on your system.

• Docker (container system): https://www.docker.com/products/docker-desktop
• Yasha (templating engine): https://github.com/kblomqvist/yasha

How things work

1. All templates are stored in the /templates folder
2. I have a Git "Pre-Commit" hook that runs build.sh
3. build.sh copies the templates and applies the templates with yasha
4. All generated files are then stored in the /generated-dockerfiles folder
5. Github Actions will read the generated files and build images from the generated files

Running things locally

Run this command to bring up a temporary local registry at localhost:5000 (Press CTRL+C to exit):

docker run --rm -p 5000:5000 --name registry registry:2

This will create a temporary local registry that we can now use for testing Dockerfiles locally, for example:

FROM localhost:5000/php:8.1-cli

CMD php -v

To do this, all I need to run is the dev.sh on my machine to run a build of all images for my local machine.

Inspect images

This is helpful for inspecting images:

docker run --rm -it localhost:5000/php:8.1-cli bash

Running a test web server:

This is helpful for testing things out:

docker run --rm -v $(pwd):/var/www/html -p 80:80 -p 443:443 localhost:5000/php:8.1-fpm-nginx