Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 5.12 KB

README.md

File metadata and controls

63 lines (49 loc) · 5.12 KB

Build & Push Docker Image

Builds release image of a project and pushes to cloud

Description

This GH Action builds a Docker image and pushes to google cloud.

A docker file as well as build arguments might be specified.

Inputs

The list of arguments, that are used in GH Action:

name type required default description
sha string ${{ github.sha }} Commit hash that will be used as a tag for the Docker image
image-name string ✅ Name of the Docker image. Might be used in the next steps (for ex.: deploy a Docker image)
build-args string Multiline string to describe build arguments that will be used during dockerization
environment enum<
temploy,
staging,
production,
>		 staging Determines additional procedures while creating a Docker image.
docker-file string Dockerfile pathname to Dockerfile
davinci-branch string master Custom davinci branch
labels string List of metadata for the Docker image
context string . Build context
push string true Push the image to the registry
platforms string linux/amd64 List of target platforms for build
tags string Additional tags for the Docker image
target string Sets the target stage to build
checkout-davinci string false Checkout davinci repository
registry-name string ✅ Registry to push the builded image
gh-runner-driver-opts string Driver options for GH Runners

Outputs

Not specified

ENV Variables

All ENV Variables, defined in a GH Workflow are also passed to a GH Action. It means, the might be reused as is. This is a list of ENV Variables that are used in GH Action:

name description
DOCKER_BUILDX_ENDPOINT Docker buildx endpoint (Optional if using for GH runners)
GITHUB_TOKEN GitHub token. Is used to checkout davinci branch
TOPTAL_BUILD_BOT_SSH_KEY SSH key to access Google cloud

Usage

  - uses: toptal/davinci-github-actions/[email protected]
    with:
      image-name: my-image-name
      environment: staging
      checkout-davinci: true
      docker-file: ./davinci/packages/ci/src/configs/docker/Dockerfile.gha-deploy
      registry-name: ${{ steps.parse_secrets.outputs.TOPTAL_DEFAULT_REGISTRY }}
      build-args: |
        ENV_RUNTIME_ENTRYPOINT=./davinci/packages/ci/src/configs/docker/env-runtime.entrypoint.sh
        DIST_FOLDER=./dist
        NGINX_CONFIG=./davinci/packages/davinci/docker/nginx-vhost.conf
        VERSION=7042976bc3db21012fe38602bb643618a95aa2d0