在部署阶段，如何在gitlab ci中添加.env文件？

Question

所以我在我的仓库中有一个我正在处理的react / typescript应用程序，在我的仓库中有一个.env文件，我忽略了它，这样我的秘密就不会暴露了。重要的.env-example文件环境变量进行配置。我的问题是，由于我没有将.env文件推送到我的存储库中，因此当我通过Google App引擎部署应用程序时（这是在gitlab-ci.yml文件的部署阶段完成的），这些环境变量会在生产环境中不存在，我需要它们才能使我的应用程序正常工作，因为我在webpack.config.js文件中执行了类似的操作。

const dotenv = require('dotenv').config({ path: __dirname + '/.env' });

然后

new webpack.DefinePlugin({
  'process.env': dotenv.parsed
})

这是我的.gitlab-ci文件，以防万一有人在这里看到。

cache:
  paths:
    - node_modules/

stages:
  - build
  - test
  - deploy

Build_Site:
  image: node:8-alpine
  stage: build
  script:
    - npm install --progress=false
    - npm run-script build
  artifacts:
    expire_in: 1 week
    paths:
      - build

Run_Tests:
  image: node:8-alpine
  stage: test
  script:
    - npm install --progress=false
    - npm run-script test

Deploy_Production:
  image: google/cloud-sdk:latest
  stage: deploy
  environment: Production
  only:
    - master
  script:
    - echo $DEPLOY_KEY_FILE_PRODUCTION > /tmp/$CI_PIPELINE_ID.json
    - gcloud auth activate-service-account --key-file /tmp/$CI_PIPELINE_ID.json
    - gcloud config set project $PROJECT_ID_PRODUCTION
    - gcloud info
    - gcloud --quiet app deploy
  after_script:
    - rm /tmp/$CI_PIPELINE_ID.json

另外，请随时批评我的gitlab-ci.yml文件，以便我做得更好。

Answer 1

Gitlab 现在允许你拥有文件类型变量，这是我的使用方式。

仅供参考：在本例中是一个 Vuejs 应用程序。

然后在我的.gitlab-ci文件上：

...
before_script:
    ...
    - cp ${PRODUCTION_ENV_FILE} .env.production
script:
    ...
    - npm ci
    - npm run build
...

Answer 2

我不知道您是否仍然需要此功能，但这是我实现的目标。

1. 在gitlab存储库配置中创建环境变量

2. 创建setup_env.sh：

#!/bin/bash

echo $API_URL >> .env
echo $NODE_ENV >> .env

3. 修改您的.gitlab-ci.yml。在下面更新您的before_script:部分

  - chmod +x ./setup_env.sh
  - ./setup_env.sh

4. 在webpack.config.js化妆用https://www.npmjs.com/package/dotenv

require('dotenv').config();

这将传递文件中.env可用的变量webpack.config.js。

将此添加到您的plugins数组（添加所需的那些变量）：

    new webpack.DefinePlugin({
      'process.env.API_URL': JSON.stringify(process.env.API_URL),
      'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
      ...
    })

现在，您的部署应使用gitlab设置中指定的环境变量。

Answer 3

如果您不向其中推送任何敏感信息，则提交 .env 文件并不是一个坏习惯：

# App Configuration
PORT=3000
NODE_ENV=production
APP_ENV=APP_ENV
TZ=utc
COMMIT_SHA=COMMIT_SHA

# Rabbitmq configuration
RABBITMQ_HOST=RABBITMQ_HOST
RABBITMQ_USER=RABBITMQ_USER
RABBITMQ_PASS=RABBITMQ_PASS
RABBITMQ_PORT=RABBITMQ_PORT
...

（假设像这样的变量RABBITMQ_HOST已在 GitLab CI 环境变量中安全设置）

因此，在.gitlab-ci.yml作业中，您只需复制所需的 .env 文件，它将自动被解释：

# App Configuration
PORT=3000
NODE_ENV=production
APP_ENV=APP_ENV
TZ=utc
COMMIT_SHA=COMMIT_SHA

# Rabbitmq configuration
RABBITMQ_HOST=RABBITMQ_HOST
RABBITMQ_USER=RABBITMQ_USER
RABBITMQ_PASS=RABBITMQ_PASS
RABBITMQ_PORT=RABBITMQ_PORT
...

不需要任何棘手的东西。