Refactor OIDC code, fix linter issues, add documentation

Author: meher745

.github/workflows/go.yml

@@ -12,13 +12,15 @@ on:
       - development
     paths-ignore:
       - 'docs/**'  # Ignore changes to docs folder
+      - '**/*.md'
   # Run on pull requests to main or development branches
   pull_request:
     branches:
       - main
       - development
     paths-ignore:
-      - 'docs/**'  # Ignore changes to docs folder
+      - 'docs/**'# Ignore changes to docs folder
+      - '**/*.md'
 
 # Define the jobs that this workflow will run
 jobs:
@@ -29,15 +31,15 @@ jobs:
     # Define a matrix strategy to test against multiple Go versions
     strategy:
       matrix:
-        go-version: ['1.24','1.23', '1.22']
+        go-version: ['1.25','1.24', '1.23']
       # Continue with other jobs if one version fails
       fail-fast: false
 
     # Define service containers that tests depend on
     services:
       # Kafka service
       kafka:
-        image: bitnami/kafka:3.4
+        image: bitnami/kafka:3.4.1
         ports:
           - "9092:9092"
         env:
@@ -120,7 +122,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go-version: ['1.24','1.23', '1.22']
+        go-version: ['1.25','1.24', '1.23']
       fail-fast: false
 
     steps:
@@ -146,15 +148,39 @@ jobs:
         with:
           timeout_minutes: 5
           max_attempts: 2
+          retry_on: error
           command: |
             export APP_ENV=test
-            # Run tests with coverage for root gofr package only
-            go test -v -short -covermode=atomic -coverpkg=./pkg/gofr -coverprofile=gofr_only.cov ./pkg/gofr
-            # Run tests for all sub-packages under gofr
-            go test -v -covermode=atomic -coverpkg=./pkg/gofr -coverprofile=submodules.cov ./pkg/gofr/...
+
+            # Run tests for root gofr package
+            go test -v -short -covermode=atomic \
+              -coverpkg=./pkg/gofr -coverprofile=gofr_only.cov ./pkg/gofr
+            exit_code=$?
+            if [ $exit_code -eq 2 ]; then
+              echo "::error::Panic detected in root gofr package tests"
+              exit 2
+            elif [ $exit_code -ne 0 ]; then
+              echo "::error::Root gofr package tests failed"
+              exit $exit_code
+            fi
+
+            # Run tests for sub-packages
+            go test -v -covermode=atomic \
+              -coverpkg=./pkg/gofr -coverprofile=submodules.cov ./pkg/gofr/...
+            exit_code=$?
+            if [ $exit_code -eq 2 ]; then
+              echo "::error::Panic detected in gofr sub-packages tests"
+              exit 2
+            elif [ $exit_code -ne 0 ]; then
+              echo "::error::Gofr sub-packages tests failed"
+              exit $exit_code
+            fi
+
             # Combine coverage profiles
             echo "mode: atomic" > profile.cov
             grep -h -v "mode:" gofr_only.cov submodules.cov | grep -v '/mock_' >> profile.cov
+
+            # Show coverage summary
             go tool cover -func profile.cov
 
       # Upload coverage report for the 1.24 Go version only
@@ -208,7 +234,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go-version:  ['1.24','1.23', '1.22']
+        go-version:  ['1.25','1.24', '1.23']
       fail-fast: false
 
     steps:
@@ -264,7 +290,7 @@ jobs:
             
               # Copy coverage file to the coverage_reports directory
               cp ${module_name}.cov ../../../coverage_reports/
-              
+            
               cd -
             '
 
@@ -275,45 +301,52 @@ jobs:
           name: submodule-coverage-reports
           path: coverage_reports/*.cov
 
-  # Job for uploading coverage to external services (CodeClimate)
-#  upload_coverage:
-#    name: Upload Coverage📊
-#    runs-on: ubuntu-latest
-#    # This job only needs example and pkg test results, not submodules
-#    needs: [Example-Unit-Testing, PKG-Unit-Testing]
-#    # Only run this job on pushes to the development branch
-#    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/development'}}
-#    steps:
-#      - name: Check out code into the Go module directory
-#        uses: actions/checkout@v5
-#
-#      # Download coverage artifacts
-#      - name: Download Coverage Report
-#        uses: actions/download-artifact@v5
-#        with:
-#          path: artifacts
-#
-#      # Merge coverage from example and pkg tests only
-#      - name: Merge Coverage Files
-#        working-directory: artifacts
-#        run: |
-#          echo "mode: set" > merged_profile.cov
-#          tail -n +2 ./Example-Test-Report/profile.cov >> merged_profile.cov
-#          tail -n +2 ./PKG-Coverage-Report/profile.cov >> merged_profile.cov
-#
-#          # Generate and print total coverage percentage
-#          echo "Total Coverage:"
-#          go tool cover -func=merged_profile.cov | tail -n 1
-#        shell: bash
-#
-#      # Upload merged coverage to CodeClimate for analysis
-#      - name: Upload
-#        uses: paambaati/[email protected]
-#        env:
-#          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
-#        with:
-#          coverageLocations: artifacts/merged_profile.cov:gocov
-#          prefix: gofr.dev
+  # Job for uploading coverage to external services (qlty.sh)
+  upload_coverage:
+    name: Upload Coverage📊
+    runs-on: ubuntu-latest
+    env:
+      QLTY_TOKEN: ${{ secrets.QLTY_TOKEN }}
+      QLTY_COVERAGE_TOKEN: ${{ secrets.QLTY_TOKEN }}
+
+    # This job only needs example and pkg test results, not submodules
+    needs: [Example-Unit-Testing, PKG-Unit-Testing]
+    # Only run this job on pushes to the development branch
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/development'}}
+    steps:
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v5
+
+      - name: Install qlty CLI
+        run: |
+          curl https://qlty.sh | sh
+          echo "$HOME/.qlty/bin" >> $GITHUB_PATH
+
+      # Download coverage artifacts
+      - name: Download Coverage Report
+        uses: actions/download-artifact@v5
+        with:
+          path: artifacts
+
+      # Merge coverage from example and pkg tests only
+      - name: Merge Coverage Files
+        working-directory: artifacts
+        run: |
+          echo "mode: set" > merged_profile.cov
+          tail -n +2 ./Example-Test-Report/profile.cov >> merged_profile.cov
+          tail -n +2 ./PKG-Coverage-Report/profile.cov >> merged_profile.cov
+
+          # Generate and print total coverage percentage
+          echo "Total Coverage:"
+          go tool cover -func=merged_profile.cov | tail -n 1
+        shell: bash
+
+      # Upload merged coverage to CodeClimate for analysis
+      - name: Upload
+        working-directory: artifacts
+        run: qlty coverage publish merged_profile.cov --format=coverprofile --strip-prefix="gofr.dev/" --add-prefix="${GITHUB_WORKSPACE}/"
+        env:
+          QLTY_TOKEN: ${{ secrets.QLTY_TOKEN }}
 
   # Job for code quality checks
   code_quality:
@@ -326,13 +359,13 @@ jobs:
       - name: Set up Go environment
         uses: actions/setup-go@v5
         with:
-          go-version: '1.24'
+          go-version: '1.25'
           cache: false
 
       # Install the linting tool
       - name: Install golangci-lint
         run: |
-          go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.1
+          go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.4.0
 
       - name: Get dependencies
         run: |
@@ -373,7 +406,7 @@ jobs:
       - name: Set up Go environment
         uses: actions/setup-go@v5
         with:
-          go-version: 1.24
+          go-version: 1.25
 
       # Check file naming conventions using ls-lint
       - name: Check for file names errors

.github/workflows/typos.yml

@@ -11,4 +11,4 @@ jobs:
       - name: Checkout Code
         uses: actions/checkout@v5
       - name: typos-action
-        uses: crate-ci/typos@v1.35.3
+        uses: crate-ci/typos@v1.36.2

.github/workflows/website.yml renamed to .github/workflows/website-prod.yml

@@ -6,9 +6,7 @@ on:
   push:
     tags:
       - "v*.*.*"
-    branches:
-      - main
-      - development
+
 env:
   APP_NAME: gofr-website
   WEBSITE_REGISTRY: ghcr.io
@@ -39,7 +37,7 @@ jobs:
         with:
           registry: us-central1-docker.pkg.dev
           username: _json_key
-          password: ${{ secrets.deploy_key }}
+          password: ${{ secrets.GOFR_WEBSITE_GOFR_DEV_DEPLOYMENT_KEY }}
 
       - name: Log in to the GitHub Container registry
         uses: docker/login-action@v3
@@ -74,35 +72,7 @@ jobs:
       - id: output-image
         run: echo "image=`echo us-central1-docker.pkg.dev/${{ env.GAR_PROJECT }}/${{ env.GAR_REGISTRY }}/${{ env.APP_NAME }}:${{ env.TAG }}`" >> "$GITHUB_OUTPUT"
 
-  deployment_stage:
-    runs-on: ubuntu-latest
-    if: ${{ github.ref == 'refs/heads/development' }}
-    name: 🚀 Deploy-Stage
-    needs: dockerize
-    container:
-      image: ghcr.io/zopsmart/gha-images:deployments-0.1.3
-      options: --rm
-    env:
-      image: ${{needs.dockerize.outputs.image}}
-
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v5
-
-      - name: Authorize to GCP service account
-        uses: google-github-actions/auth@v2
-        with:
-          credentials_json: ${{ secrets.deploy_key }}
-
-      - name: Set GCloud Project and Fetch Cluster Credentials
-        run: gcloud container clusters get-credentials ${{ env.CLUSTER_NAME }} --region=us-central1 --project=${{ env.CLUSTER_PROJECT }}
-
-      - name: Update Deployment Image
-        run: kubectl set image deployment/${{ env.APP_NAME }} ${{ env.APP_NAME }}=${{ env.image }} --namespace ${{ env.NAMESPACE_STAGE }}
-
-
   deployment:
-    if: ${{ startsWith(github.ref, 'refs/tags/v')}}
     runs-on: ubuntu-latest
     name: 🚀 Deploy-Prod
     needs: dockerize
@@ -117,9 +87,9 @@ jobs:
         uses: actions/checkout@v5
 
       - name: Authorize to GCP service account
-        uses: google-github-actions/auth@v2
+        uses: google-github-actions/auth@v3
         with:
-          credentials_json: ${{ secrets.deploy_key }}
+          credentials_json: ${{ secrets.GOFR_WEBSITE_GOFR_DEV_DEPLOYMENT_KEY }}
 
       - name: Set GCloud Project and Fetch Cluster Credentials
         run: gcloud container clusters get-credentials ${{ env.CLUSTER_NAME }} --region=us-central1 --project=${{ env.CLUSTER_PROJECT }}

.github/workflows/website-stage.yml

@@ -0,0 +1,99 @@
+name: Build and Deploy Website To Stage
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+      - development
+
+env:
+  APP_NAME: gofr-website
+  WEBSITE_REGISTRY: ghcr.io
+  GAR_PROJECT: raramuri-tech
+  GAR_REGISTRY: kops-dev
+  CLUSTER_NAME: raramuri-tech
+  CLUSTER_PROJECT: raramuri-tech
+  NAMESPACE: gofr-dev
+  NAMESPACE_STAGE: gofr-dev-stg
+
+jobs:
+  dockerize:
+    permissions:
+      contents: read
+      packages: write
+    runs-on: ubuntu-latest
+    outputs:
+      image: ${{ steps.output-image.outputs.image }}
+    name: 🐳 Dockerize
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v5
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to GAR
+        uses: docker/login-action@v3
+        with:
+          registry: us-central1-docker.pkg.dev
+          username: _json_key
+          password: ${{ secrets.GOFR_WEBSITE_GOFR_DEV_STG_DEPLOYMENT_KEY }}
+
+      - name: Log in to the GitHub Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.WEBSITE_REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Download UI Image
+        run: |
+          docker pull ${{ env.WEBSITE_REGISTRY }}/gofr-dev/website:latest
+
+      - name: Determine Image Tag
+        id: determine-tag
+        run: |
+          if [[ "${{ github.ref }}" == refs/tags/* ]]; then
+            TAG=${GITHUB_REF#refs/tags/}
+          else
+            TAG=${{ github.sha }}
+          fi
+          echo "TAG=$TAG" >> $GITHUB_ENV
+
+
+      - name: Build and Push Image
+        uses: docker/build-push-action@v6
+        with:
+          push: true
+          context: ./
+          file: ./docs/Dockerfile
+          tags: us-central1-docker.pkg.dev/${{ env.GAR_PROJECT }}/${{ env.GAR_REGISTRY }}/${{ env.APP_NAME }}:${{ env.TAG }}
+
+      - id: output-image
+        run: echo "image=`echo us-central1-docker.pkg.dev/${{ env.GAR_PROJECT }}/${{ env.GAR_REGISTRY }}/${{ env.APP_NAME }}:${{ env.TAG }}`" >> "$GITHUB_OUTPUT"
+
+  deployment_stage:
+    runs-on: ubuntu-latest
+    name: 🚀 Deploy-Stage
+    needs: dockerize
+    container:
+      image: ghcr.io/zopsmart/gha-images:deployments-0.1.3
+      options: --rm
+    env:
+      image: ${{needs.dockerize.outputs.image}}
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v5
+
+      - name: Authorize to GCP service account
+        uses: google-github-actions/auth@v3
+        with:
+          credentials_json: ${{ secrets.GOFR_WEBSITE_GOFR_DEV_STG_DEPLOYMENT_KEY }}
+
+      - name: Set GCloud Project and Fetch Cluster Credentials
+        run: gcloud container clusters get-credentials ${{ env.CLUSTER_NAME }} --region=us-central1 --project=${{ env.CLUSTER_PROJECT }}
+
+      - name: Update Deployment Image
+        run: kubectl set image deployment/${{ env.APP_NAME }} ${{ env.APP_NAME }}=${{ env.image }} --namespace ${{ env.NAMESPACE_STAGE }}