Skip to content

Latest commit

 

History

History
127 lines (119 loc) · 4.7 KB

docker-build-readme.md

File metadata and controls

127 lines (119 loc) · 4.7 KB
Raw

Build Docker and Push Image to Docker Hub

Purpose

This GitHub Actions workflow is designed to perform the following tasks:

  1. Build a Docker image based on the provided service location.
  2. Push the Docker image to Docker Hub.
  3. Notify the team through Slack in case of any failures.

Inputs

This workflow accepts the following inputs:

  • SERVICE_NAME (Required, String): The name of your service.
  • SERVICE_LOCATION (Required, String): The relative path to your service within the repository.
  • BUILD_ARTIFACT (Optional, String): The name of the build artifact.
  • NPM_BUILD (Optional, Boolean): Set to true if you want to build docker for NPM application.
  • ONLY_DOCKER (Optional, Boolean): Set to true if you only want to build the Docker image with a GitHub artifacts.

Secrets

This workflow requires the following secrets to be set in your GitHub repository:

  • RELEASE_DOCKER_HUB: The Docker Hub repository where the image will be pushed.
  • ACTOR_DOCKER_HUB: The Docker Hub username of the actor performing the push.
  • DEV_NAMESPACE_DOCKER_HUB: The Docker Hub namespace or organization.
  • SLACK_WEBHOOK_URL: The Slack webhook URL for notifications.

Example Usage

Here is an example workflow that uses the build-dockers workflow:

  • Docker build for maven application: 
    jobs:
  build-docker:
    needs: <job-name>
    strategy:
      matrix:
        include:
          - SERVICE_LOCATION: '<SERVICE-LOCATION>'
            SERVICE_NAME: '<SERVICE-NANE>'
            BUILD_ARTIFACT: '<GITHUB-ARTIFACT-NAME>'
      fail-fast: false
    name: ${{ matrix.SERVICE_NAME }}
    uses: mosip/kattu/.github/workflows/docker-build.yml@master
    with:
      SERVICE_LOCATION: ${{ matrix.SERVICE_LOCATION }}
      SERVICE_NAME: ${{ matrix.SERVICE_NAME }}
      BUILD_ARTIFACT: ${{ matrix.BUILD_ARTIFACT }}
    secrets:
      DEV_NAMESPACE_DOCKER_HUB: ${{ secrets.DEV_NAMESPACE_DOCKER_HUB }}
      ACTOR_DOCKER_HUB: ${{ secrets.ACTOR_DOCKER_HUB }}
      RELEASE_DOCKER_HUB: ${{ secrets.RELEASE_DOCKER_HUB }}
      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}
  • Docker build for NPM application: 
    jobs:
  build-docker:
    needs: <job-name>
    strategy:
      matrix:
        include:
          - SERVICE_LOCATION: '<SERVICE-LOCATION>'
            SERVICE_NAME: '<SERVICE-NANE>'
            BUILD_ARTIFACT: '<GITHUB-ARTIFACT-NAME>'
            NPM_BUILD: true
      fail-fast: false
    name: ${{ matrix.SERVICE_NAME }}
    uses: mosip/kattu/.github/workflows/docker-build.yml@master
    with:
      SERVICE_LOCATION: ${{ matrix.SERVICE_LOCATION }}
      SERVICE_NAME: ${{ matrix.SERVICE_NAME }}
      BUILD_ARTIFACT: ${{ matrix.BUILD_ARTIFACT }}
      NPM_BUILD: ${{ matrix.NPM_BUILD }}
    secrets:
      DEV_NAMESPACE_DOCKER_HUB: ${{ secrets.DEV_NAMESPACE_DOCKER_HUB }}
      ACTOR_DOCKER_HUB: ${{ secrets.ACTOR_DOCKER_HUB }}
      RELEASE_DOCKER_HUB: ${{ secrets.RELEASE_DOCKER_HUB }}
      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}
  • Docker build without GitHub artifacts. 
    jobs:
  build-docker:
    needs: <job-name>
    strategy:
      matrix:
        include:
          - SERVICE_LOCATION: '<SERVICE-LOCATION>'
            SERVICE_NAME: '<SERVICE-NANE>'
      fail-fast: false
    name: ${{ matrix.SERVICE_NAME }}
    uses: mosip/kattu/.github/workflows/docker-build.yml@master
    with:
      SERVICE_LOCATION: ${{ matrix.SERVICE_LOCATION }}
      SERVICE_NAME: ${{ matrix.SERVICE_NAME }}
    secrets:
      DEV_NAMESPACE_DOCKER_HUB: ${{ secrets.DEV_NAMESPACE_DOCKER_HUB }}
      ACTOR_DOCKER_HUB: ${{ secrets.ACTOR_DOCKER_HUB }}
      RELEASE_DOCKER_HUB: ${{ secrets.RELEASE_DOCKER_HUB }}
      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}
  • Docker build with GitHub artifacts. 
    jobs:
  build-docker:
    needs: <job-name>
    strategy:
      matrix:
        include:
          - SERVICE_LOCATION: '<SERVICE-LOCATION>'
            SERVICE_NAME: '<SERVICE-NANE>'
            BUILD_ARTIFACT: '<GITHUB-ARTIFACT-NAME>'
            ONLY_DOCKER: true
      fail-fast: false
    name: ${{ matrix.SERVICE_NAME }}
    uses: mosip/kattu/.github/workflows/docker-build.yml@master
    with:
      SERVICE_LOCATION: ${{ matrix.SERVICE_LOCATION }}
      SERVICE_NAME: ${{ matrix.SERVICE_NAME }}
      BUILD_ARTIFACT: ${{ matrix.BUILD_ARTIFACT  || false }}
      ONLY_DOCKER: ${{ matrix.ONLY_DOCKER  || false }}
    secrets:
      DEV_NAMESPACE_DOCKER_HUB: ${{ secrets.DEV_NAMESPACE_DOCKER_HUB }}
      ACTOR_DOCKER_HUB: ${{ secrets.ACTOR_DOCKER_HUB }}
      RELEASE_DOCKER_HUB: ${{ secrets.RELEASE_DOCKER_HUB }}
      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}