Use GitLab CI to build, deploy, restart the NextJS PM2 server in the AWS instance

deploy deploy.sh

# !/bin/bash

# <*> Add DEPLOY_SERVER_USER variable with the value of instanse user(eg:ubuntu) in GitLab CI setting.
# <*> Add DEPLOY_SERVER_URL variable with the value of instanse url(eg:http://ec2-XXXXX.XXX.amazonaws.com/) in GitLab CI setting.

echo "Deploying to ${DEPLOY_SERVER_USER}@${DEPLOY_SERVER_URL}"
ssh ${DEPLOY_SERVER_USER}@${DEPLOY_SERVER_URL} 'bash' < ./deploy/server.sh

deploy server.sh

# <*> replace PROJECT_DIRECTORY with you directory
cd PROJECT_DIRECTORY
git checkout .
git pull

# Build and deploy
npm ci
npm run build

# replace PM2_SERVICE_NAME with you pm2 name
pm2 restart PM2_SERVICE_NAME

exit

GitLab CI NextJS PM2 AWS .gitlab-ci.yml

#Path: PROJECT_DIRECTORY/.gitlab-ci.yml

stages:
  - build
  - deploy

building:
  stage: build
  image: node:16
  variables:
    NODE_ENV: "production"
  script:
    - npm install
    - npm run build
  cache:
    key: ${CI_PROJECT_ID}
    paths:
      - node_modules/
      - .next/cache/

deployment:
  stage: deploy
  only:
    - main
    - master
  before_script:
    - apt-get update -qq
    - apt-get install -qq git
    - apt-get install -y npm
    # Setup SSH deploy keys
    - "which ssh-agent || ( apt-get install -qq openssh-client )"
    - eval $(ssh-agent -s)
    # <*> Add SSH_PRIVATE_KEY variable with the value of your SSL private key of the AWS in GitLab CI setting.
    - ssh-add <(echo "$SSH_PRIVATE_KEY")  
    - mkdir -p ~/.ssh
    - '[[ -f /.dockerenv ]] && echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config'
  environment:
    name: production
  script:
    - bash ./deploy/deploy.sh