Skip to content

Commit

Permalink
formatting README
Browse files Browse the repository at this point in the history
  • Loading branch information
cansavvy authored Jan 8, 2025
1 parent fa27ac9 commit 71e0ad1
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 71e0ad1

Please sign in to comment.