Running Composer and NPM scripts with deployment via SCP in GitLab CI/CD

原文：https://docs.gitlab.com/ee/ci/examples/deployment/composer-npm-deploy.html

Running Composer and NPM scripts with deployment via SCP in GitLab CI/CD

本指南涵盖了在使用GitLab CI / CD通过 NPM 脚本编译资产时，如何构建 PHP 项目的依赖项.

虽然可以使用自定义的 PHP 和 Node.js 版本创建自己的映像，但为了简便起见，我们将使用既包含 PHP 又安装 Node.js 的现有Docker 映像 .

  1. image: tetraweb/php

下一步是安装 zip / unzip 软件包并使 composer 可用. 我们将它们放在before_script部分中：

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

这将确保我们已准备好所有要求. 接下来，我们要运行composer install来获取所有 PHP 依赖项，然后运行npm install来加载 Node.js 包，然后运行npm脚本. 我们需要将它们附加到before_script部分：

  1. before_script:
  2.   # ...
  3.   - php composer.phar install
  4.   - npm install
  5.   - npm run deploy

在此特定情况下， npm deploy脚本是执行以下操作的 Gulp 脚本：

  1. 编译 CSS 和 JS
  2. Create sprites
  3. 复制各种资产（图像，字体）
  4. 替换一些字符串

所有这些操作会将所有文件放入一个build文件夹，该文件夹准备好部署到实时服务器中.

How to transfer files to a live server

您有多种选择：rsync，SCP，SFTP 等. 现在，我们将使用 SCP.

为此，您需要添加一个 GitLab CI / CD 变量（可在gitlab.example/your-project-name/variables ）. 该变量将称为STAGING_PRIVATE_KEY ，它是服务器的私密 SSH 密钥.

Security tip

创建一个仅可以访问需要更新的文件夹的用户.

创建该变量后，需要确保在运行时将密钥添加到 Docker 容器中：

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

按顺序，这意味着：

  1. 我们检查ssh-agent是否可用，如果没有，则安装它.
  2. 我们创建~/.ssh文件夹.
  3. 我们确保正在运行 bash.
  4. 我们禁用主机检查（当我们首次连接到服务器时，我们不要求用户接受，并且由于每个作业都将等同于首次连接，因此我们有点需要这样做）.

这基本上是您在before_script部分中所需要的.

How to deploy

如上所述，我们需要将 Docker 镜像中的build文件夹部署到我们的服务器. 为此，我们创建了一个新作业：

  1. stage_deploy:
  2.   artifacts:
  3.     paths:
  4.       - build/
  5.   only:
  6.     - dev
  7.   script:
  8.     - ssh-add <(echo "$STAGING_PRIVATE_KEY")
  9.     - ssh -p22 server_user@server_host "mkdir htdocs/wp-content/themes/_tmp"
  10.     - scp -P22 -r build/* server_user@server_host:htdocs/wp-content/themes/_tmp
  11.     - 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"
  12.     - ssh -p22 server_user@server_host "rm -rf htdocs/wp-content/themes/_old"

这是细分：

  1. only:dev表示仅当将某些内容推送到dev分支时，此构建才会运行. 您可以完全删除此块，并在每次推送时都运行所有内容（但是这可能是您不想要的）
  2. ssh-add ...我们会将您在 Web UI 上添加的私钥添加到 Docker 容器中
  3. 我们将通过ssh连接并创建一个新的_tmp文件夹
  4. 我们将通过scp连接并将build文件夹（由npm脚本生成）上传到我们先前创建的_tmp文件夹中
  5. 我们将再次通过ssh连接，然后将live文件夹移至_old文件夹，然后将_tmp移至live .
  6. 我们连接到 SSH 并删除_old文件夹

这些文物怎么处理？ 我们只是告诉 GitLab CI / CD 保留build目录（以后，您可以根据需要下载该目录）.

Why we do it this way

如果仅将其用于舞台服务器，则可以分两个步骤进行操作：

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

问题在于，服务器将在短时间内没有该应用程序.

因此，对于生产环境，我们使用其他步骤来确保在任何给定时间都可以使用功能正常的应用程序.

Where to go next

由于这是一个 WordPress 项目，因此我给出了真实的代码片段. 您可以追求一些进一步的想法：

  • master分支的脚本稍有不同，将使您可以从该分支部署到生产服务器，并从任何其他分支部署到阶段服务器.
  • 除了将其实时发布之外，您还可以将其推送到 WordPress 官方存储库（创建 SVN 提交等）.
  • 您可以动态生成 i18n 文本域.

我们最终的.gitlab-ci.yml将如下所示：

  1. image: tetraweb/php
  3. before_script:
  4.   - apt-get update
  5.   - apt-get install zip unzip
  6.   - php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
  7.   - php composer-setup.php
  8.   - php -r "unlink('composer-setup.php');"
  9.   - php composer.phar install
  10.   - npm install
  11.   - npm run deploy
  12.   - 'which  ssh-agent  ||  (  apt-get  update  -y  &&  apt-get  install  openssh-client  -y  )'
  13.   - mkdir -p ~/.ssh
  14.   - eval $(ssh-agent -s)
  15.   - '[[  -f  /.dockerenv  ]]  &&  echo  -e  "Host  *\n\tStrictHostKeyChecking  no\n\n"  >  ~/.ssh/config'
  17. stage_deploy:
  18.   artifacts:
  19.     paths:
  20.       - build/
  21.   only:
  22.     - dev
  23.   script:
  24.     - ssh-add <(echo "$STAGING_PRIVATE_KEY")
  25.     - ssh -p22 server_user@server_host "mkdir htdocs/wp-content/themes/_tmp"
  26.     - scp -P22 -r build/* server_user@server_host:htdocs/wp-content/themes/_tmp
  27.     - 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"
  28.     - ssh -p22 server_user@server_host "rm -rf htdocs/wp-content/themes/_old"