From 71e0ad18caab2435ef55be804476b8c00609caee Mon Sep 17 00:00:00 2001 From: Candace Savonen Date: Tue, 7 Jan 2025 20:33:58 -0500 Subject: [PATCH] formatting README --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 23afa5f..2c1e498 100644 --- a/README.md +++ b/README.md @@ -26,24 +26,24 @@ Example of a docker image manual rebuild settings: ## Adding a new image -1. Make a new directory -2. Put your Dockerfile in this directory. Make sure it is named "Dockerfile" exactly. -3. Open up `pull_request.yml` and find where there is a comment like this: +1. Make a new directory +2. Put your Dockerfile in this directory. Make sure it is named "Dockerfile" exactly. +3. Open up `pull_request.yml` and find where there is a comment like this: ``` # NEW IMAGES HERE: # ####### - {dir: directory_path, name: 'name its called on dockerhub'} ``` -4. Follow the same format as the other images in this repository and add a line to this list underneath `matrix:` +4. Follow the same format as the other images in this repository and add a line to this list underneath `matrix:` ``` - {dir: directory_path, name: 'name its called on dockerhub'} ``` -For example it should look something like: +For example it should look something like: ``` - {dir: base_ottr, name: 'jhudsl/base_ottr'} ``` -Where `base_ottr` is the path to the directory where the Dockerfile is stored inside the folder named `base_ottr` and `jhudsl/base_ottr` is what it is called on Dockerhub. -5. Develop your Dockerfile as your normally would but with each push to your open pull request `pull_request.yml` will attempt to rebuild it to test it. -6. When it successfully builds and it has what you want then you can have it reviewed and merged. -7. Upon merging `merge.yml` will rebuild the image one more time and then push to Dockerhub (if it has proper credentials to do so). Dockerhub username and Dockerhub token stored in this repository as GitHub secrets needs to have push access to the image on Dockerhub. +Where `base_ottr` is the path to the directory where the Dockerfile is stored inside the folder named `base_ottr` and `jhudsl/base_ottr` is what it is called on Dockerhub. +5. Develop your Dockerfile as your normally would but with each push to your open pull request `pull_request.yml` will attempt to rebuild it to test it. +6. When it successfully builds and it has what you want then you can have it reviewed and merged. +7. Upon merging `merge.yml` will rebuild the image one more time and then push to Dockerhub (if it has proper credentials to do so). Dockerhub username and Dockerhub token stored in this repository as GitHub secrets needs to have push access to the image on Dockerhub. For more information on any of this ask @cansavvy.