feat(makefile): adding docker-build and docker-run targets to the makefile

[atallison]

Description

Adding three new make file targets, make docker-build, make docker-run and make docker for convenience in building and running the docker image of the project.

Fixes #49

Current status

• Waiting for review
• Waiting for comment resolution
• Waiting for merge
• Draft

Semantic Versioning

• This is a feat change

Type of change

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Manual

1. Navigate to the project directory in the terminal
2. Enter make docker-build
3. Verify that a new image is created in docker desktop
4. Change the REGISTRY_IMAGE_NAME variable in the make file
5. Re-run make docker-build
6. Verify that the new image is tagged with the updated variable
7. Enter make docker-run
8. Ensure that the image is used in a container that runs
9. Enter make docker
10. Ensure that the docker image is made and a container is run with the image

Checklist:

• My commit message mentions fix, feat, BREAKING CHANGE accordingly to increase the semantic versioning
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have checked my code/docs and corrected any misspellings

[haani-niyaz]

@atallison Thanks for taking this one up! I've left some review comments.

[haani-niyaz]

@atallison I would replace the var name with DOCKER_REPO for 2 reasons: the prefix DOCKER signifies the scope and a docker repo is usually synonymous with <registry>/<image>.

I would also replace the value to rog-golang-buddies/template.

[haani-niyaz]

Given that we can run this as make docker REGISTRY_IMAGE_NAME=template override the image, we should also use DOCKER_TAG with a default value of latest. That way the tag can be explicitly set, specially in CI.

[haani-niyaz]

@atallison, We should probably add the --rm option to automatically removes the container on exit.

[haani-niyaz]

@atallison, Can we keep the help messages consistent? "Build" instead of "Builds" etc.

Maybe we should update the message to "Runs the docker image built via [make docker-build]" to separate out that it is a command?