AYS-509 | AysMaskUtil Has Been Refactored and Improved (#425)
#226
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Purpose: Deploy the backend to the test environment. | |
| # Name of the workflow | |
| name: Deploy to Test Environment | |
| on: | |
| push: | |
| branches: | |
| - main # Trigger the workflow when a push event occurs on the main branch | |
| jobs: | |
| build: # Define the "build" job | |
| runs-on: ubuntu-latest # Run the job on the latest version of Ubuntu | |
| steps: # List of steps to execute within the job | |
| - name: Update package cache # Step to update the package cache | |
| run: sudo apt-get update | |
| - name: Checkout code # Step to check out the code from the repository | |
| uses: actions/checkout@v3 | |
| - name: Set up Java # Step to set up the Java environment | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: 17 # Specify Java 17 as the version | |
| distribution: 'zulu' # Use the 'zulu' distribution of Java | |
| - name: Set up Docker # Step to set up the Docker environment | |
| uses: actions/hello-world-docker-action@v2 | |
| - name: Install Maven # Step to install Maven | |
| run: sudo apt-get install -y maven | |
| - name: Copy settings.xml file from template # Step to create a new 'settings.xml' file by copying the 'template-settings.xml' | |
| run: cp template-settings.xml settings.xml | |
| - name: Replace username in settings.xml # Step to replace the placeholder username in settings.xml | |
| run: sed 's|'{YOUR_GITHUB_USERNAME}'|'${{ secrets.GH_USERNAME }}'|g' settings.xml >> temp-settings.xml ; rm settings.xml ; mv temp-settings.xml settings.xml | |
| - name: Replace access token in settings.xml # Step to replace the placeholder access token in settings.xml | |
| run: sed 's|'{YOUR_PERSONAL_GITHUB_ACCESS_TOKEN}'|'${{ secrets.GH_USER_ACCESS_TOKEN }}'|g' settings.xml >> temp-settings.xml ; rm settings.xml ; mv temp-settings.xml settings.xml | |
| - name: Cache SonarQube packages # Caching packages related to SonarQube | |
| uses: actions/cache@v4 # To use GitHub Actions' cache action | |
| with: # The section where parameters are defined for the GitHub Actions action | |
| path: ~/.sonar/cache | |
| key: ${{ runner.os }}-sonar | |
| restore-keys: ${{ runner.os }}-sonar # If the key does not match exactly, the cache will be restored with similar keys. | |
| - name: Cache Maven packages # Caching of Maven packages | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.m2 | |
| key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} | |
| restore-keys: ${{ runner.os }}-m2 | |
| - name: Build and analyze # SonarQube integration and Maven execution | |
| env: | |
| SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} | |
| SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }} | |
| SONAR_PROJECT_KEY: ${{ secrets.SONAR_PROJECT_KEY }} | |
| run: mvn --settings settings.xml -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=${{ secrets.SONAR_PROJECT_KEY }} -Dsonar.projectName='ays-be' | |
| - name: Starting Deployment to ECS... # Step to start the deployment to ECS | |
| run: echo "Starting Deployment to ECS..." | |
| - name: Configure AWS credentials # Step to 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: ${{ secrets.AWS_REGION }} | |
| - name: Login to Amazon ECR # Step to log in to Amazon ECR | |
| id: login-ecr | |
| uses: aws-actions/amazon-ecr-login@v1 | |
| - name: Build, tag, and push image to Amazon ECR # Step to build, tag, and push the image to Amazon ECR | |
| id: build-image | |
| env: | |
| ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }} | |
| ECR_REPOSITORY: ays-be-test | |
| IMAGE_TAG: ${{ github.sha }} | |
| run: | | |
| docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG . | |
| docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG | |
| echo "image=$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG" >> $GITHUB_OUTPUT | |
| - name: Download task definition # Step to download the task definition | |
| run: | | |
| aws ecs describe-task-definition --task-definition ays-be-test \ | |
| --query taskDefinition > task_definition.json | |
| - name: Fill in the new image ID in the Amazon ECS task definition # Step to 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: task_definition.json | |
| container-name: ays-be-test | |
| image: ${{ steps.build-image.outputs.image }} | |
| - name: Deploy Amazon ECS task definition # Step to deploy the Amazon ECS task definition | |
| uses: aws-actions/amazon-ecs-deploy-task-definition@v1 | |
| with: | |
| task-definition: ${{ steps.task-def.outputs.task-definition }} | |
| service: ays-be-test-service | |
| cluster: ays-be-test-cluster | |
| wait-for-service-stability: true | |
| - name: Deployment successfully completed # Step to indicate that the deployment was successful | |
| run: echo "Deployment successfully completed!" | |