Feature 39 setup build and publish image

.github/workflows/maven.yml

@@ -10,6 +10,10 @@ on:
  branches:
  - '**'
 
+env:
+ REGISTRY: ghcr.io
+ IMAGE_NAME: ${{ github.repository }}
+
 jobs:
  build:
 
@@ -21,5 +25,30 @@ jobs:
  with:
  distribution: 'temurin'
  java-version: '17'
+
+ - name: Login to GitHub Container Registry
+ uses: docker/login-action@v2
+ with:
+ registry: ghcr.io
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+
  - name: Build Backend
- run: cd power-pay-backend && mvn package
+ run: cd power-pay-backend && mvn package
+
+ - id: string
+ uses: ASzc/change-string-case-action@v6
+ with:
+ string: ${{github.repository}}
+ - id: Convert_string_to_lowercase
+ run: echo ${{ steps.string.outputs.lowercase }}
+
+ - name: Build and push image
+ uses: docker/build-push-action@v5
+ with:
+ context: ./power-pay-backend
+ file: ./power-pay-backend/Dockerfile
+ push: true
+ tags: ghcr.io/${{ github.repository }}:latest
+
+

.github/workflows/node.yml

@@ -22,5 +22,29 @@ jobs:
  node-version: 18
  - name: Npm install
  run: cd power-pay-frontend && npm ci
+
+ - name: Login to the Docker registry
+ uses: docker/login-action@v2
+ with:
+ registry: ghcr.io
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+
  - name: Build Frontend
- run: cd power-pay-frontend && npm run build
+ run: cd power-pay-frontend && npm run build
+
+ - id: string
+ uses: AsZc/change-string-case-action@v6
+ with:
+ string: ${{github.repository}}
+ - id: Convert_string_to_lowercase
+ run: echo ${{ steps.string.outputs.lowercase}}
+
+ - name: Build and push
+ uses: docker/build-push-action@v4
+ with:
+ context: ./power-pay-frontend
+ file: ./power-pay-frontend/Dockerfile
+ push: true
+ tags: ghcr.io/${{ github.repository }}:latest
+

.github/workflows/rust.yml

@@ -21,4 +21,26 @@ jobs:
  steps:
  - uses: actions/checkout@v4
  - name: Build Translator
- run: cd power-pay-translator && cargo build --verbose && cargo test --verbose
+ run: cd power-pay-translator && cargo build --verbose && cargo test --verbose
+
+ - name: Login to the Docker registry
+ uses: docker/login-action@v3
+ with:
+ registry: ghcr.io
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+
+ - id: String
+ uses: AsZc/change-string-case-action@v6
+ with: 
+ string: ${{ github.repository }}
+ - id: Convert_String_to_lowercase
+ run: echo ${{ steps.string.outputs.lowercase }}
+
+ - name: Build and push Docker image
+ uses: docker/build-push-action@v5
+ with:
+ context: ./power-pay-translator
+ file: ./power-pay-translator/Dockerfile
+ push: true
+ tags: ghcr.io/${{ github.repository }}:latest

docs/Setup-build-and-push-docker-images.md

@@ -0,0 +1,16 @@
+# Building and Uploading Docker Images to ghcr.io using Github Action
+This document outlines the steps to build a Docker image and upload it to ghcr.io using a Github Action. The process involves building the frontend, backend and using a translator service to communicate with them.
+
+## Prerequisites
+- A Github repository for each sub-project with a Dockerfile.
+- A personal access token (PAT) with write:packages scope. You can create a PAT by following these steps: [Github Docs ](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
+
+### Steps
+1- Create new files named .github/workflows/maven.yml, .github/workflows/node.yml, and .github/workflows/rust.yml in the main project directory for the backend, frontend and translator respectively.
+2 - In the above created files, define the Github Action workflow for each.
+3- Save the various .yml files.
+4- Commit and push the changes to your repository.
+5- Github Action will automatically trigger the workflow defined in the above files whenever pushed to the mentioned branch.
+6- The workflow will build the frontend, backend and translator Docker images using their respective Dockerfiles and push them to ghcr.io using the provided credentials.
+7- You can access the Docker images on ghcr.io at ghcr.io/<owner>/<repository>/<image>:<tag>, where <owner> is your GitHub username or organization, <repository> is the name of your repository, <image> is the name of the Docker image(frontend, backend or translator) and <tag> is the SHA of the commit.
+8- Make sure to update your deployment or other relevant scripts to use the newly built Docker images from ghcr.io.