GitLab CI/CD를 통한 SCP를 사용한 Composer 및 npm 스크립트 실행

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

이 안내서에서는 GitLab CI/CD를 사용하여 PHP 프로젝트의 종속 항목을 빌드하고 npm 스크립트를 통해 에셋을 컴파일하는 방법을 다룹니다.

사용자 정의 PHP 및 Node.js 버전이 포함된 이미지를 만들 수 있지만, 이번 안내서에서는 기존 Docker 이미지를 사용하므로 이미지를 만들지 않겠습니다. 

image: tetraweb/php

다음 단계는 zip/unzip 패키지를 설치하고 composer를 사용할 수 있도록 하는 것입니다. 이를 before_script 섹션에 넣습니다. 

before_script:
  - apt-get update
  - apt-get install zip unzip
  - php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
  - php composer-setup.php
  - php -r "unlink('composer-setup.php');"

이렇게 하면 모든 요구 사항을 갖추게 됩니다. 다음으로 composer install을 실행하여 모든 PHP 종속성을 가져오고, npm install을 실행하여 Node.js 패키지를 로드합니다. 그런 다음 npm 스크립트를 실행해야 하는데, 이를 before_script 섹션에 추가해야 합니다. 

before_script:
  # ...
  - php composer.phar install
  - npm install
  - npm run deploy

이 경우 npm deploy 스크립트는 다음 작업을 수행하는 Gulp 스크립트입니다:

  1. CSS 및 JS 컴파일
  2. 스프라이트 생성
  3. 다양한 에셋(이미지, 글꼴) 복사
  4. 일부 문자열 교체

이 모든 작업을 통해 모든 파일이 라이브 서버로 전송될 준비가 된 build 폴더에 위치하게 됩니다.

라이브 서버로 파일 전송하는 방법

rsync, SCP 또는 SFTP와 같은 여러 옵션이 있습니다. 현재는 SCP를 사용합니다.

이를 작동하려면 GitLab CI/CD 변수를 추가해야 합니다 (gitlab.example/your-project-name/variables에서 액세스 가능). 이 변수의 이름을 STAGING_PRIVATE_KEY로 지정하고 서버의 개인 SSH 키로 설정해야 합니다.

보안 팁

업데이트해야 하는 폴더에 만 액세스할 수 있는 사용자를 만듭니다.

변수를 만든 후에는 해당 키가 실행될 때 Docker 컨테이너에 추가되었는지 확인하세요. 

before_script:
  # - ....
  - 'which ssh-agent || ( apt-get update -y && apt-get install openssh-client -y )'
  - mkdir -p ~/.ssh
  - eval $(ssh-agent -s)
  - '[[ -f /.dockerenv ]] && echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config'

이를 통해 다음을 수행합니다:

  1. ssh-agent를 사용할 수 있는지 확인하고 사용할 수 없다면 설치합니다.
  2. ~/.ssh 폴더를 만듭니다.
  3. bash를 실행하는지 확인합니다.
  4. 호스트 확인을 비활성화합니다(처음으로 서버에 연결할 때 사용자 수락을 요청받지 않으며, 모든 작업이 첫 번째 연결과 동일하기 때문에 필요합니다).

이것이 before_script 섹션에서 필요한 모든 것입니다.

배포 방법

위에서 설명한 대로 Docker 이미지의 build 폴더를 서버로 배포해야 합니다. 이를 위해 새 작업을 만듭니다: 

stage_deploy:
  artifacts:
    paths:
      - build/
  rules:
    - if: $CI_COMMIT_BRANCH == "dev"
  script:
    - ssh-add <(echo "$STAGING_PRIVATE_KEY")
    - ssh -p22 server_user@server_host "mkdir htdocs/wp-content/themes/_tmp"
    - scp -P22 -r build/* server_user@server_host:htdocs/wp-content/themes/_tmp
    - ssh -p22 server_user@server_host "mv htdocs/wp-content/themes/live htdocs/wp-content/themes/_old && mv htdocs/wp-content/themes/_tmp htdocs/wp-content/themes/live"
    - ssh -p22 server_user@server_host "rm -rf htdocs/wp-content/themes/_old"

세부적으로 살펴보겠습니다:

  1. rules:if: $CI_COMMIT_BRANCH == "dev"는 이 빌드가 dev 브랜치로 푸시되었을 때에만 실행된다는 의미입니다. 이 블록을 완전히 제거하고 모든 푸시에서 모든 것을 실행하도록 할 수 있지만, 아마도 원하지 않을 것입니다.
  2. ssh-add ...로 웹 UI에서 추가한 해당 개인 키를 Docker 컨테이너에 추가합니다.
  3. ssh를 통해 연결하고 새 _tmp 폴더를 만듭니다.
  4. scp를 통해 npm 스크립트에 의해 생성된 build 폴더를 이전에 만든 _tmp 폴더에 업로드합니다.
  5. 다시 ssh를 통해 live 폴더를 _old 폴더로 이동한 다음 _tmp를 live로 이동합니다.
  6. SSH로 연결하여 _old 폴더를 제거합니다.

아티팩트가 무엇인가요? GitLab CI/CD에 build 디렉토리를 유지하도록 지시합니다(나중에 필요할 때 다운로드할 수 있습니다).

왜 우리는 이렇게 하는가

이걸 단순히 스테이지 서버에만 사용하는 경우, 두 단계로 수행할 수 있습니다: 

- ssh -p22 server_user@server_host "rm -rf htdocs/wp-content/themes/live/*"
- scp -P22 -r build/* server_user@server_host:htdocs/wp-content/themes/live

문제는 앱을 서버에 올리지 않는 짧은 기간이 있습니다.

따라서 실제 운영 환경에서는 언제나 기능적인 앱이 있는지 보장하기 위해 추가 단계를 사용합니다.

다음 단계

이 프로젝트는 워드프레스 프로젝트였기 때문에 실제 코드 스니펫이 포함되어 있습니다. 몇 가지 추가 아이디어를 추구할 수 있습니다:

  • 기본 브랜치에 대해 약간 다른 스크립트를 가지고 있어 해당 브랜치에서는 프로덕션 서버로, 다른 브랜치에서는 스테이지 서버로 배포할 수 있습니다.
  • 실시간으로 푸시하는 대신 WordPress 공식 저장소에 푸시할 수 있습니다.
  • i18n 텍스트 도메인을 실시간으로 생성할 수 있습니다.

최종 .gitlab-ci.yml은 다음과 같습니다: 

stage_deploy:
  image: tetraweb/php
  artifacts:
    paths:
      - build/
  rules:
    - if: $CI_COMMIT_BRANCH == "dev"
  before_script:
    - apt-get update
    - apt-get install zip unzip
    - php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
    - php composer-setup.php
    - php -r "unlink('composer-setup.php');"
    - php composer.phar install
    - npm install
    - npm run deploy
    - 'which ssh-agent || ( apt-get update -y && apt-get install openssh-client -y )'
    - mkdir -p ~/.ssh
    - eval $(ssh-agent -s)
    - '[[ -f /.dockerenv ]] && echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config'
  script:
    - ssh-add <(echo "$STAGING_PRIVATE_KEY")
    - ssh -p22 server_user@server_host "mkdir htdocs/wp-content/themes/_tmp"
    - scp -P22 -r build/* server_user@server_host:htdocs/wp-content/themes/_tmp
    - ssh -p22 server_user@server_host "mv htdocs/wp-content/themes/live htdocs/wp-content/themes/_old && mv htdocs/wp-content/themes/_tmp htdocs/wp-content/themes/live"
    - ssh -p22 server_user@server_host "rm -rf htdocs/wp-content/themes/_old"