Add CD with github actions (#704)

Author: brunoparma88

.github/workflows/cd.yml

@@ -0,0 +1,63 @@
+name: CD
+
+on:
+  workflow_dispatch:
+  #   push:
+      # Uncomment and add the necessary branches to enable automatic deployment on AWS
+      # branches:
+        # - main
+
+jobs:
+  deploy:
+    name: Deploy on AWS ECS
+    runs-on: ubuntu-latest
+    environment:
+      name: ${{ github.ref == 'refs/heads/main' && 'production' || github.ref_name }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ vars.AWS_REGION }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to Amazon ECR
+        uses: aws-actions/amazon-ecr-login@v1
+
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.login-ecr.outputs.registry }}/${{ vars.ECR_REPOSITORY }}:${{ github.sha }}
+
+      - name: Get the image digest
+        id: image-digest
+        run: echo "image=${{ steps.login-ecr.outputs.registry }}/${{ vars.ECR_REPOSITORY }}:${{ github.sha }}" >> $GITHUB_OUTPUT
+
+      - name: Download task definition
+        run: |
+          aws ecs describe-task-definition --task-definition ${{ vars.ECS_TASK_DEFINITION }} --query taskDefinition > ${{ vars.ECS_TASK_DEFINITION_PATH }}
+
+      - name: Fill in the new image ID in the Amazon ECS task definition
+        id: task-def
+        uses: aws-actions/amazon-ecs-render-task-definition@v1
+        with:
+          task-definition: ${{ vars.ECS_TASK_DEFINITION_PATH }}
+          container-name: ${{ vars.CONTAINER_NAME }}
+          image: ${{ steps.image-digest.outputs.image }}
+
+      - name: Deploy Amazon ECS task definition
+        uses: aws-actions/amazon-ecs-deploy-task-definition@v1
+        with:
+          task-definition: ${{ steps.task-def.outputs.task-definition }}
+          service: ${{ vars.ECS_SERVICE }}
+          cluster: ${{ vars.ECS_CLUSTER }}
+          wait-for-service-stability: true

docs/cd_with_aws.md

@@ -0,0 +1,47 @@
+# Continuous Deployment with AWS
+
+This document explains how to set up Continuous Deployment (CD) with AWS using GitHub Actions.
+
+## Prerequisites
+
+Before you start, make sure you have the following:
+
+1. **AWS Account**: You need an AWS account. Sign up [here](https://aws.amazon.com/).
+
+2. **Amazon ECR (Elastic Container Registry) Setup**: 
+   - Create a new repository in Amazon ECR.
+   - Note down the repository URI, which will be used in the GitHub Actions workflow.
+
+3. **AWS Credentials**: 
+   - AWS Access Key ID
+   - AWS Secret Access Key
+   - These credentials should have permission to interact with ECR and ECS.
+
+4. **Create Environments**:
+
+   The GitHub Actions workflow will automatically deploy to the correct environment based on the branch being pushed to. The branch `main` will always be linked to the `production` environment, while other branches will use their own names as the environment. All environments added in GitHub must have the same name as the branches.
+
+5. **GitHub Repository Setup**:
+   - **Environment Secrets**: Add the following secrets to your GitHub environments (these are specific to each environment and not set at the repository level):
+     - `AWS_ACCESS_KEY_ID`: Your AWS Access Key ID.
+     - `AWS_SECRET_ACCESS_KEY`: Your AWS Secret Access Key.
+   - **Environment Variables**: Add the following variables to your GitHub environments:
+     - `AWS_REGION`: The region where your ECR and ECS are set up (e.g., `us-east-1`).
+     - `ECR_REPOSITORY`: The name of your ECR repository.
+     - `ECS_TASK_DEFINITION`: The ARN of your ECS task definition.
+     - `ECS_TASK_DEFINITION_PATH`: The path to your ECS task definition file.
+     - `CONTAINER_NAME`: The name of the container defined in your ECS task definition.
+     - `ECS_SERVICE`: The name of your ECS service.
+     - `ECS_CLUSTER`: The name of your ECS cluster.
+
+6. **GitHub Actions Workflow**:
+   To set up the GitHub Actions workflow for continuous deployment to AWS, you need to modify the existing cd.yml file in the .github/workflows directory of your GitHub repository.
+
+   Uncomment the branches section under `on: push:` and add the necessary branches to enable automatic deployment. For example:
+
+   ```yaml
+   on:
+     push:
+       branches:
+         - main
+         - dev