程式語言 › Ruby

在 Ruby 中使用 CircleCI 進行 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"

執行 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 檔案並重新部署即可。