Workflow.yaml 文件用于EC2实例持续部署使用GitHub Actions

Question

I am having issues with the .yaml workflow file, as I do not know what it should look like. For instance, I do not know how to set up SSH connection to the server using key-pair and what should be the other jobs that I have to declare in order for the continuous deployment to be functioning properly? Thanks in advance.

This is what I have so far in the.yaml file

name: develop-deploy

concurrency: development

on:
  push:
    branches: [ deploy ]
  pull_request:
    branches: [ deploy ]

env:
  AWS_REGION: eu-central-1                  # Frankfurt
  
jobs:
  deployment:
    name: Deploy
    runs-on: self-hosted
    environment: development
    concurrency: development
    
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v1
        with:
          node-version: ${{ matrix.node-version }}
      - 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: ${{ env.AWS_REGION }}

      - name: Connect to EC2 server instance using SSH
        uses: 
      - run: 
 
      - name: Deploy to my EC2 instance
        uses: easingthemes/ssh-deploy@v2.1.5
        env:
          # Have to figure out a way to put the key-pair in secrets
          SSH_PRIVATE_KEY: ${{ secrets.EC2_SSH_KEY }}
          SOURCE: "./"
          REMOTE_HOST: # address
          REMOTE_USER: # user
          #TARGET:

      - name: Propagate changes and deploy on server
      - run:
          sudo docker-compose down
          git pull
          sudo docker-compose up -d
          # Getting inside the node container
          npm install
          npm run schema:sync

Answer 1

I build a .yml file for my personal project, It basically get the private key , hostname , and username from github secrets and then it stores in env.

then I ssh into my ec2, and after it I update my repo.

After it I upload a folder to my ec2 using ssh

And then start the pm2 server again.

For reference you can check this yml file

To Load private-key , hostname , and username

jobs:
  ci:
    name: CI
    runs-on: ubuntu-latest
    env:
      PRIVATE_KEY: ${{ secrets.CLIENT_KEY  }}
      HOSTNAME : ${{ secrets.CLIENT_HOSTNAME  }}
      USER_NAME : ${{ secrets.CLIENT_USERNAME  }}

Changing private-key permissions and storing it locally inside github-action

- name: Changing permissions of PRIVATE_KEY
  run: echo "$PRIVATE_KEY" > private_key && chmod 600 private_key

To ssh into ec2 and perform some operations

- name: SSH into ec2 and do operations
  run: |
    ssh -o StrictHostKeyChecking=no -i private_key ${USER_NAME}@${HOSTNAME} '
      cd my/folder

      git checkout
      git fetch --all
      git reset --hard origin/main
      git pull origin main

      # These commands are executing inside ec2
    '

To upload a folder into ec2

- name: Uploading folder to ec2
  run: scp -o StrictHostKeyChecking=no -i private_key -r my-folder ${USER_NAME}@${HOSTNAME}:/home/ubuntu/my-folder

Answer 2

For everyone having this or a similar issue, take a look at this link: https://farhan-tanvir.medium.com/ci-cd-from-github-to-aws-ec2-using-github-action-e18b621c0507 . I found it extremely helpful, hope it helps anyone with the problem. The yaml file looks like this:

name: CI/CD counter app

on: push: branches: [ master ]

jobs:

build: runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2

- name: Build the docker_compose
  run: docker-compose up -d --build
  
- name: Buid the application
  run: docker-compose exec -T counter_app npm run build

Deploy: needs: build runs-on: ubuntu-latest

steps:
  - uses: actions/checkout@v2 
  - name: Deploy in EC2
    env:
        PRIVATE_KEY: ${{ secrets.AWS_PRIVATE_KEY  }}
        HOSTNAME : ${{ secrets.HOSTNAME  }}
        USER_NAME : ${{ secrets.USER_NAME  }}
        
    run: |
      echo "$PRIVATE_KEY" > private_key && chmod 600 private_key
      ssh -o StrictHostKeyChecking=no -i private_key ${USER_NAME}@${HOSTNAME} '
      
        #Now we have got the access of EC2 and we will start the deploy .
        cd /home/ubuntu/CounterApp &&
        git checkout master &&
        git fetch --all &&
        git reset --hard origin/master &&
        git pull origin master &&
        docker-compose -f docker-compose.prod.yml up -d --build 
      '