Github actions for automatic image build

[Shreyanand]

The backend and frontend images have to be build manually after updates. Add Github actions or its alternatives for building and updating the images automatically when changes are made to respective code in the main branch.

[RHETbot]

This issue aims to automate the process of building Docker images for the backend and frontend components using GitHub Actions. Currently, the process is manual, which can delay updates and reduce efficiency.

The suggested next steps include:

1. Evaluating current manual steps for building images.
2. Designing a GitHub Actions workflow triggered on repository changes.
3. Implementing pipeline jobs using actions like docker/build-push-action to automate image building and pushing.
4. Testing the workflow to ensure images are correctly built and pushed.
5. Updating project documentation with the new process.
6. Notifying stakeholders and closing or updating the issue once automation is confirmed.

A sample GitHub Actions workflow YAML has been provided below for your reference, which automates building and pushing Docker images for both backend and frontend folders:

name: Build and Push Docker Images

on:
  push:
    branches:
      - main

jobs:
  build-and-push:
    name: Build and Push Docker Images
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Log in to Docker Hub
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKER_USERNAME }}
          password: ${{ secrets.DOCKER_PASSWORD }}

      - name: Set variables
        run: |
          IMAGE_TAG=${GITHUB_SHA::8}
          echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_ENV

      - name: Build and push backend image
        uses: docker/build-push-action@v3
        with:
          context: ./backend
          push: true
          tags: yourdockerhubusername/backend:latest, yourdockerhubusername/backend:${{ env.IMAGE_TAG }}

      - name: Build and push frontend image
        uses: docker/build-push-action@v3
        with:
          context: ./frontend
          push: true
          tags: yourdockerhubusername/frontend:latest, yourdockerhubusername/frontend:${{ env.IMAGE_TAG }}

Please replace placeholders with your actual Docker Hub username, and ensure secrets are properly configured.

Would you like further customization or assistance with deployment?

[RHETbot]

Hi team,

Based on the issue regarding automating Docker image builds for the backend and frontend, the root cause appears to be the current manual process—which can be error-prone, time-consuming, and less scalable—necessitating manual intervention after each update.

Research & Insights:

• Automating image builds through CI/CD workflows like GitHub Actions can streamline the process, improve consistency, and reduce manual effort.
• Several resources confirm that setting up workflows triggered by push events to the main branch can automate building and pushing Docker images to registries.
• The docker/build-push-action (version 6 or later) is a popular and well-supported choice for such workflows.
• Proper handling of secrets for registry credentials is essential for automation security.

Proposed Next Steps:

1. Review the current repository structure and Dockerfiles to ensure compatibility with automated workflows.
2. Design and implement GitHub Actions workflows:
   • Trigger on pushes to the main branch.
   • Build Docker images for both backend and frontend components.
   • Push the built images to the designated container registry (e.g., Docker Hub, Quay, etc.).
3. Test the workflows thoroughly in a feature branch before merging into the main branch.
4. Verify that images are correctly built and updated upon each code change.
5. Document the new automated process for team awareness and future maintenance.

Additional Resources:

• GitHub Marketplace Action: build-and-push-docker
• Medium Guide: Automate Docker Builds using GitHub Actions
• Docker Docs: Automate builds with GitHub Actions

Implementing this automation will significantly improve our deployment efficiency and reduce manual errors. Please advise if you'd like me to proceed with drafting the actual workflow files or further refine this plan.