Updated github actions. Avoiding duplication of docker login step. Added a composite reusable action. Updated Readme.

vinodbhorge · vinodbhorge · commit 30d105e863a0 · 2025-05-22T15:32:45.000+05:30
diff --git a/.github/actions/registry-login/action.yml b/.github/actions/registry-login/action.yml
@@ -0,0 +1,44 @@
+name: "Container Registry Login"
+description: "Reusable action for logging in to container registries using workflow inputs"
+inputs:
+  registry_provider:
+    required: false
+  gcp_service_account_key:
+    required: false
+  registry_name:
+    required: false
+  registry_url:
+    required: false
+  registry_username:
+    required: false
+  registry_password:
+    required: false
+  github_token:
+    required: false
+runs:
+  using: "composite"
+  steps:
+    - run: |
+        case "${{ inputs.registry_provider }}" in
+          "gcp")
+            echo "Using Google Container Registry"
+            echo "${{ inputs.gcp_service_account_key }}" | base64 --decode > $HOME/gcloud-key.json
+            gcloud auth activate-service-account --key-file=$HOME/gcloud-key.json
+            gcloud auth configure-docker ${{ inputs.registry_name }}
+            REGISTRY_URL=$(echo "${{ inputs.registry_url }}" | tr '[:upper:]' '[:lower:]')
+            ;;
+          "azure" | "dockerhub")
+            echo "Logging in to Container Registry"
+            echo "${{ inputs.registry_password }}" | docker login ${{ inputs.registry_name }} \
+              --username ${{ inputs.registry_username }} --password-stdin
+            REGISTRY_URL=$(echo "${{ inputs.registry_url }}" | tr '[:upper:]' '[:lower:]')
+            ;;
+          *)
+            echo "Using GitHub Container Registry (GHCR)"
+            REPO_NAME_LOWERCASE=$(echo "${GITHUB_REPOSITORY}" | tr '[:upper:]' '[:lower:]')
+            echo "${{ inputs.github_token }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
+            REGISTRY_URL="ghcr.io/$REPO_NAME_LOWERCASE"
+            ;;
+        esac
+        echo "REGISTRY_URL=${REGISTRY_URL}" >> $GITHUB_ENV
+      shell: bash
diff --git a/.github/workflows/content-service.yml b/.github/workflows/content-service.yml
@@ -22,15 +22,27 @@ jobs:
           java-version: '11'
           cache: 'maven'
 
-      # Step 3: Build the project
+      # Step 3: Set up Login to Docker registry
+      - name: Registry Login
+        uses: ./.github/actions/registry-login
+        with:
+          registry_provider: ${{ vars.REGISTRY_PROVIDER }}
+          gcp_service_account_key: ${{ secrets.GCP_SERVICE_ACCOUNT_KEY }}
+          registry_name: ${{ secrets.REGISTRY_NAME }}
+          registry_url: ${{ secrets.REGISTRY_URL }}
+          registry_username: ${{ secrets.REGISTRY_USERNAME }}
+          registry_password: ${{ secrets.REGISTRY_PASSWORD }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      # Step 4: Build the project
       - name: Build Content Service
         run: |
           mvn clean install -DskipTests=true \
             -DCLOUD_STORE_GROUP_ID=${{ vars.CLOUD_STORE_GROUP_ID }} \
             -DCLOUD_STORE_ARTIFACT_ID=${{ vars.CLOUD_STORE_ARTIFACT_ID }} \
             -DCLOUD_STORE_VERSION=${{ vars.CLOUD_STORE_VERSION }}
 
-      # Step 4: Package the project
+      # Step 5: Package the project
       - name: Package Content Service
         run: |
           cd content-api
@@ -39,33 +51,6 @@ jobs:
             -DCLOUD_STORE_ARTIFACT_ID=${{ vars.CLOUD_STORE_ARTIFACT_ID }} \
             -DCLOUD_STORE_VERSION=${{ vars.CLOUD_STORE_VERSION }}
 
-      # Step 5: Set up Login to Docker registry
-      - name: Determine registry and login
-        run: |
-          case "${{ vars.REGISTRY_PROVIDER }}" in
-            "gcp")
-              echo "Using Google Container Registry"
-              echo "${{ secrets.GCP_SERVICE_ACCOUNT_KEY }}" | base64 --decode > $HOME/gcloud-key.json
-              gcloud auth activate-service-account --key-file=$HOME/gcloud-key.json
-              gcloud auth configure-docker ${{ secrets.REGISTRY_NAME }}
-              REGISTRY_URL=$(echo "${{ secrets.REGISTRY_URL }}" | tr '[:upper:]' '[:lower:]')
-              ;;
-            "azure" | "dockerhub")
-              echo "Logging in to Container Registry"
-              echo "${{ secrets.REGISTRY_PASSWORD }}" | docker login ${{ secrets.REGISTRY_NAME }} \
-                --username ${{ secrets.REGISTRY_USERNAME }} --password-stdin
-              REGISTRY_URL=$(echo "${{ secrets.REGISTRY_URL }}" | tr '[:upper:]' '[:lower:]')
-              ;;
-            *)
-              echo "Using GitHub Container Registry (GHCR)"
-              REPO_NAME_LOWERCASE=$(echo "${GITHUB_REPOSITORY}" | tr '[:upper:]' '[:lower:]')
-              echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
-              REGISTRY_URL="ghcr.io/$REPO_NAME_LOWERCASE"
-              ;;
-          esac
-
-          echo "REGISTRY_URL=${REGISTRY_URL}" >> $GITHUB_ENV
-
       # Step 6: Build Docker image 
       - name: Build Docker Image
         run: |
@@ -75,7 +60,8 @@ jobs:
 
           echo "IMAGE_NAME=${IMAGE_NAME}" >> $GITHUB_ENV
           echo "IMAGE_TAG=${IMAGE_TAG}" >> $GITHUB_ENV
-
+     
+      # Step 7: Push Docker Image
       - name: Push Docker Image
         run: |
           docker push $REGISTRY_URL/${IMAGE_NAME}:${IMAGE_TAG}
diff --git a/.github/workflows/search-service.yml b/.github/workflows/search-service.yml
@@ -22,6 +22,18 @@ jobs:
           java-version: '11'
           cache: 'maven'
 
+      # Step 3: Set up Login to Docker registry
+      - name: Registry Login
+        uses: ./.github/actions/registry-login
+        with:
+          registry_provider: ${{ vars.REGISTRY_PROVIDER }}
+          gcp_service_account_key: ${{ secrets.GCP_SERVICE_ACCOUNT_KEY }}
+          registry_name: ${{ secrets.REGISTRY_NAME }}
+          registry_url: ${{ secrets.REGISTRY_URL }}
+          registry_username: ${{ secrets.REGISTRY_USERNAME }}
+          registry_password: ${{ secrets.REGISTRY_PASSWORD }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
       # Step 4: Build the project
       - name: Build Search API Service
         run: |
@@ -39,34 +51,7 @@ jobs:
             -DCLOUD_STORE_ARTIFACT_ID=${{ vars.CLOUD_STORE_ARTIFACT_ID }} \
             -DCLOUD_STORE_VERSION=${{ vars.CLOUD_STORE_VERSION }}
 
-      # Step 6: Set up Login to Docker registry
-      - name: Determine registry and login
-        run: |
-          case "${{ vars.REGISTRY_PROVIDER }}" in
-            "gcp")
-              echo "Using Google Container Registry"
-              echo "${{ secrets.GCP_SERVICE_ACCOUNT_KEY }}" | base64 --decode > $HOME/gcloud-key.json
-              gcloud auth activate-service-account --key-file=$HOME/gcloud-key.json
-              gcloud auth configure-docker ${{ secrets.REGISTRY_NAME }}
-              REGISTRY_URL=$(echo "${{ secrets.REGISTRY_URL }}" | tr '[:upper:]' '[:lower:]')
-              ;;
-            "azure" | "dockerhub")
-              echo "Logging in to Container Registry"
-              echo "${{ secrets.REGISTRY_PASSWORD }}" | docker login ${{ secrets.REGISTRY_NAME }} \
-                --username ${{ secrets.REGISTRY_USERNAME }} --password-stdin
-              REGISTRY_URL=$(echo "${{ secrets.REGISTRY_URL }}" | tr '[:upper:]' '[:lower:]')
-              ;;
-            *)
-              echo "Using GitHub Container Registry (GHCR)"
-              REPO_NAME_LOWERCASE=$(echo "${GITHUB_REPOSITORY}" | tr '[:upper:]' '[:lower:]')
-              echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
-              REGISTRY_URL="ghcr.io/$REPO_NAME_LOWERCASE"
-              ;;
-          esac
-
-          echo "REGISTRY_URL=${REGISTRY_URL}" >> $GITHUB_ENV
-
-      # Step 7: Build Docker image
+      # Step 6: Build Docker image
       - name: Build Docker Image
         run: |
           IMAGE_NAME="search-api"
@@ -76,7 +61,7 @@ jobs:
           echo "IMAGE_NAME=${IMAGE_NAME}" >> $GITHUB_ENV
           echo "IMAGE_TAG=${IMAGE_TAG}" >> $GITHUB_ENV
 
-      # Step 8: Push Docker Image
+      # Step 7: Push Docker Image
       - name: Push Docker Image
         run: |
           docker push $REGISTRY_URL/${IMAGE_NAME}:${IMAGE_TAG}
diff --git a/.github/workflows/taxonomy-service.yml b/.github/workflows/taxonomy-service.yml
@@ -22,6 +22,18 @@ jobs:
           java-version: '11'
           cache: 'maven'
 
+       # Step 3: Set up Login to Docker registry
+      - name: Registry Login
+        uses: ./.github/actions/registry-login
+        with:
+          registry_provider: ${{ vars.REGISTRY_PROVIDER }}
+          gcp_service_account_key: ${{ secrets.GCP_SERVICE_ACCOUNT_KEY }}
+          registry_name: ${{ secrets.REGISTRY_NAME }}
+          registry_url: ${{ secrets.REGISTRY_URL }}
+          registry_username: ${{ secrets.REGISTRY_USERNAME }}
+          registry_password: ${{ secrets.REGISTRY_PASSWORD }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
       # Step 4: Build the project
       - name: Build Taxonomy API Service
         run: |
@@ -39,34 +51,7 @@ jobs:
             -DCLOUD_STORE_ARTIFACT_ID=${{ vars.CLOUD_STORE_ARTIFACT_ID }} \
             -DCLOUD_STORE_VERSION=${{ vars.CLOUD_STORE_VERSION }}
 
-      # Step 6: Set up Login to Docker registry
-      - name: Determine registry and login
-        run: |
-          case "${{ vars.REGISTRY_PROVIDER }}" in
-            "gcp")
-              echo "Using Google Container Registry"
-              echo "${{ secrets.GCP_SERVICE_ACCOUNT_KEY }}" | base64 --decode > $HOME/gcloud-key.json
-              gcloud auth activate-service-account --key-file=$HOME/gcloud-key.json
-              gcloud auth configure-docker ${{ secrets.REGISTRY_NAME }}
-              REGISTRY_URL=$(echo "${{ secrets.REGISTRY_URL }}" | tr '[:upper:]' '[:lower:]')
-              ;;
-            "azure" | "dockerhub")
-              echo "Logging in to Container Registry"
-              echo "${{ secrets.REGISTRY_PASSWORD }}" | docker login ${{ secrets.REGISTRY_NAME }} \
-                --username ${{ secrets.REGISTRY_USERNAME }} --password-stdin
-              REGISTRY_URL=$(echo "${{ secrets.REGISTRY_URL }}" | tr '[:upper:]' '[:lower:]')
-              ;;
-            *)
-              echo "Using GitHub Container Registry (GHCR)"
-              REPO_NAME_LOWERCASE=$(echo "${GITHUB_REPOSITORY}" | tr '[:upper:]' '[:lower:]')
-              echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
-              REGISTRY_URL="ghcr.io/$REPO_NAME_LOWERCASE"
-              ;;
-          esac
-
-          echo "REGISTRY_URL=${REGISTRY_URL}" >> $GITHUB_ENV
-
-      # Step 7: Build Docker image
+      # Step 6: Build Docker image
       - name: Build Docker Image
         run: |
           IMAGE_NAME="taxonomy-api"
@@ -76,7 +61,7 @@ jobs:
           echo "IMAGE_NAME=${IMAGE_NAME}" >> $GITHUB_ENV
           echo "IMAGE_TAG=${IMAGE_TAG}" >> $GITHUB_ENV
 
-      # Step 8: Push Docker Image
+      # Step 7: Push Docker Image
       - name: Push Docker Image
         run: |
           docker push $REGISTRY_URL/${IMAGE_NAME}:${IMAGE_TAG}
diff --git a/README.md b/README.md
@@ -212,6 +212,8 @@ To ensure the GitHub Actions workflows in this repository function correctly, th
 1. **Secrets Configuration**:
    - Ensure the secrets are configured in your GitHub repository, depending on the value of `REGISTRY_PROVIDER`. The workflow will push the image to the respective container registry if the required credentials are provided.
 
+   - Note: If No REGISTRY_PROVIDER is provided the image will be pushed to GHCR.
+
     #### GCP (Google Cloud Platform)
     - `REGISTRY_PROVIDER`: Set to `gcp`
     - `GCP_SERVICE_ACCOUNT_KEY`: Base64-encoded service account key for GCP.
