语言 › Ruby

使用 CircleCI 进行 Ruby 的 CI/CD

使用加密的 .env.vault 文件在 CircleCI 中运行 Ruby CI/CD

初始设置

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

build.rb

# build.rb
puts "Hello #{ENV["HELLO"]}"

创建一个 Gemfile 文件。

Gemfile

# frozen_string_literal: true

source "https://rubygems.org.cn"

运行 bundle install 以生成 Gemfile.lock 文件。

bundle install

创建一个名为 .circleci/config.yml 的文件。

.circleci/config.yml

# .circleci/config.yml
version: 2.1
orbs:
  ruby: circleci/[email protected]
jobs:
  build:
    docker:
      - image: cimg/ruby:2.7.3
    steps:
      - checkout
      - ruby/install-deps
      - run:
          name: Ruby build
          command: ruby build.rb

将所有内容提交到代码并推送到 GitHub。然后将你的 GitHub 仓库连接到 CircleCI。

app.circleci.com

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

安装 dotenv-vault

安装 dotenv-vault。

bundle add dotenv-vault

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

.env

# .env
HELLO="World"

在应用程序中尽早导入并配置 dotenv-vault 以及 bundler/setup。

build.rb

# build.rb
require "bundler/setup"
require "dotenv-vault/load"
puts "Hello #{ENV["HELLO"]}"

尝试在本地运行它。

ruby build.rb
Hello World

完美。现在 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

在 CircleCI 上设置 DOTENV_KEY。

app.circleci.com

构建 CI

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

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

app.circleci.com 构建

当你看到日志中出现 'Loading env from encrypted .env.vault' 时，你就知道一切正常。如果没有设置 DOTENV_KEY（例如，在本地机器上开发时），它将回退到标准的 dotenv 功能。

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