https://github.com/getindata/docker-image-template

Docker image template - boilerplate used to simplify creation of new docker images
https://github.com/getindata/docker-image-template

Last synced: 3 months ago
JSON representation

Docker image template - boilerplate used to simplify creation of new docker images

• Host: GitHub
• URL: https://github.com/getindata/docker-image-template
• Owner: getindata
• License: apache-2.0
• Created: 2022-12-22T14:25:24.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-02T14:42:27.000Z (over 3 years ago)
• Last Synced: 2025-01-24T02:31:04.348Z (over 1 year ago)
• Language: Dockerfile
• Size: 11.7 KB
• Stars: 3
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# 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!!!

![Docker Image Version (latest by date)](https://img.shields.io/docker/v/getindata/docker-image-template?arch=amd64&logo=docker&sort=date&style=for-the-badge)

![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/getindata/docker-image-template?logo=docker&sort=date&style=for-the-badge)

![Docker Pulls](https://img.shields.io/docker/pulls/getindata/docker-image-template?logo=docker&style=for-the-badge)

[![build test scan docker images](https://github.com/getindata/docker-image-template/actions/workflows/pr_opened.yml/badge.svg)](https://github.com/getindata/docker-image-template/actions/workflows/pr_opened.yml)

[![create new release with changelog](https://github.com/getindata/docker-image-template/actions/workflows/release.yml/badge.svg)](https://github.com/getindata/docker-image-template/actions/workflows/release.yml)

![Docker](https://badgen.net/badge/icon/docker?icon=docker&label)

![License](https://badgen.net/github/license/getindata/docker-image-template/)

![Release](https://badgen.net/github/release/getindata/docker-image-template/)



  

  
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](./app) folder_

* _create new repository in your docker registry (by default: gcr.io/getindata-images-public/app)_

* _adjust variables `REGISTRY_*` in [.github/workflows/*.yml](./.github/workflows) 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_

```shell

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

- [app](app)

## CONTRIBUTING

Contributions are very welcomed!

Start by reviewing [contribution guide](CONTRIBUTING.md) and our [code of conduct](CODE_OF_CONDUCT.md).

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

## LICENSE

Apache 2 Licensed. See [LICENSE](LICENSE) for full details.

## AUTHORS



  



Made with [contrib.rocks](https://contrib.rocks)