Docker Image Template

Warning: This is a template document. Remember to remove all text in italics and update Dockerfile, REPO_NAME, REGISTRY variables and links/badges to the acual name of your GitHub repository!!!

We help companies turn their data into assets

How to use this template:

use this template -> create a new repository
update Dockerfile and its dependencies in app folder
create new repository in your docker registry (by default: gcr.io/getindata-images-public/app)
adjust variables REGISTRY_* in .github/workflows/*.yml based on https://github.com/marketplace/actions/docker-login#usage
create github secret REGISTRY_PASSWORD with password value with read&write permissions for your docker registry
push your changes as pull request into main/master branch
label your changes as release/major release/minor release/patch based on the desired release update
once pull request will be merged, it will trigger new release with new image tagged with symantic version available in changelog

Brief Description of Docker Image:

What it does
What technologies it uses

USAGE

Example usage of the Dockerfile

docker run --rm app:v1.0.0

NOTES

Additional information that should be made public, for ex. how to solve known issues, additional descriptions/suggestions

EXAMPLES

CONTRIBUTING

Contributions are very welcomed!

Start by reviewing contribution guide and our code of conduct.

After that, start coding and ship your changes by creating a new PR.

LICENSE

Apache 2 Licensed. See LICENSE for full details.

AUTHORS

Made with contrib.rocks

parashuramn / docker-image-template