语言 › Node.js

使用 Travis CI 在 Node.js 中实现 CI/CD

使用加密的 .env.vault 文件在 Travis CI 中运行 Node.js CI/CD

在本指南中找到一个完整的 GitHub 代码示例。

初始设置

创建一个名为 build.js 的文件。这是一个非常简单的构建脚本，输出 “Hello World”。

build.js

// build.js
console.log(`Hello ${process.env.HELLO}`)

创建一个包含测试脚本的 package.json 文件。Travis 默认情况下期望能够运行 npm test。

package.json

{
  "scripts": {
    "test": "node build.js"
  }
}

创建一个 .travis.yml 文件。

.travis.yml

# .travis.yml
language: node_js
node_js:
  - 16
install:
  - npm install

将这些内容提交到代码库并推送到 GitHub。然后连接 Travis CI

app.travis-ci.com

推送后，Travis CI 构建将显示 “'Hello undefined'”，因为它还没有访问环境变量的方法。我们接下来解决这个问题。

安装 dotenv

安装 dotenv.

npm install dotenv --save # Requires dotenv >= 16.1.0

在项目根目录下创建一个 .env 文件。

.env

# .env
HELLO="World"

在应用程序中尽可能早地导入并配置 dotenv。

build.js

// build.js
require('dotenv').config()
console.log(process.env) // remove this after you've confirmed it is working

console.log(`Hello ${process.env.HELLO}`)

尝试在本地运行它。

node build.js
{
  ...
  HELLO: 'World'
}
Hello World

完美。现在 process.env 包含你在 .env 文件中定义的键值对。

这涵盖了 CI 的本地模拟。接下来让我们解决真实的 CI 环境。

构建 .env.vault

推送你最新的 .env 文件更改，并编辑你的 CI 密钥。了解有关同步的更多信息

npx dotenv-vault@latest push
npx dotenv-vault@latest open ci

使用 UI 为每个环境配置这些密钥。

dotenv.org

然后构建你加密的 .env.vault 文件。

npx dotenv-vault@latest build

它的内容应该类似于以下内容。

.env.vault

#/-------------------.env.vault---------------------/
#/         cloud-agnostic vaulting standard         /
#/   [how it works](https://dotenv.org/env-vault)   /
#/--------------------------------------------------/

# development
DOTENV_VAULT_DEVELOPMENT="/HqNgQWsf6Oh6XB9pI/CGkdgCe6d4/vWZHgP50RRoDTzkzPQk/xOaQs="
DOTENV_VAULT_DEVELOPMENT_VERSION=2

# ci
DOTENV_VAULT_CI="x26PuIKQ/xZ5eKrYomKngM+dO/9v1vxhwslE/zjHdg3l+H6q6PheB5GVDVIbZg=="
DOTENV_VAULT_CI_VERSION=2

设置 DOTENV_KEY

获取你的 CI DOTENV_KEY。

npx dotenv-vault@latest keys ci
# outputs: dotenv://:[email protected]/vault/.env.vault?environment=ci

在 Travis CI 上设置 DOTENV_KEY。

travis-ci.com

构建 CI

将这些更改安全地提交到代码库并重新运行构建。

就是这样！在重新运行时，你的 .env.vault 文件将被解密，其 CI 密钥将被注入为环境变量——恰逢其时。

当你看到日志中显示 “'Loading env from encrypted .env.vault'” 时，就知道操作成功了。如果没有设置 DOTENV_KEY（例如，在本地机器上开发时），它将回退到标准的 dotenv 功能。

travis-ci.com

你已成功使用新的 .env.vault 标准来加密和部署你的密钥。这比将密钥散布在多个第三方平台和工具中安全得多。无论何时需要添加或更改密钥，只需重新构建你的 .env.vault 文件并重新部署即可。