refactor: Clean up deploy.yaml for improved readability and consistency

[RandithaK]

Summary by CodeRabbit

• Chores
  • Enhanced deployment pipeline configuration to support automated deployments from multiple branches and improved infrastructure management processes.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The deployment workflow is refactored to check out a separate Kubernetes configuration repository instead of using local files. Deployment triggers are expanded to include the devOps branch. Image tag modifications and deployment steps now operate on files from the externally checked-out config repository.

Changes

Cohort / File(s)

Change Summary

Deployment Workflow Configuration \.github/workflows/deploy\.yaml

Modified deployment trigger branches to include devOps alongside main; replaced initial code checkout and commit SHA extraction with dedicated K8s config repository checkout step requiring authentication token; updated image tag modification and deployment steps to reference config-repo/k8s/services/gateway-deployment.yaml path instead of local files; retained kubectl/yq installation and rollout status check steps.

Sequence Diagram

sequenceDiagram
    participant GH as GitHub Actions
    participant ConfigRepo as Config Repository
    participant K8s as Kubernetes Cluster

    GH->>GH: Trigger on main/devOps push or workflow_run completed
    GH->>ConfigRepo: Checkout config repo with auth token
    ConfigRepo-->>GH: Provide config files
    GH->>GH: Extract commit SHA from config
    GH->>GH: Update image tag in gateway-deployment.yaml
    GH->>K8s: Apply updated deployment from config-repo path
    K8s-->>GH: Deployment status
    GH->>K8s: Check rollout status
    K8s-->>GH: Rollout complete

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Auth token handling: Verify that the GitHub token or secret name is correctly configured and has appropriate repository access permissions
• Config repository URL: Confirm the separate config repository URL is correct and won't cause deployment failures if unavailable
• Path references: Ensure all hardcoded paths (config-repo/k8s/services/gateway-deployment.yaml) match the actual structure of the config repository

Poem

🐰 A config repository hops into view,
Deployment now branches to devOps too,
With tokens and paths aligned just right,
The gateway takes flight through the Kubernetes night! ✨

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch devOps

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 88ac3f8 and ccc49b5.

📒 Files selected for processing (1)

• .github/workflows/deploy.yaml (1 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}