Ruby: 使用 GitHub Actions 部署

如何利用 GitHub Actions 部署您的 Ruby 程式碼

👋 歡迎來到 Stackhero 文檔！

Stackhero 提供一個即用型的 Ruby cloud 解決方案，帶來多項好處，包括：

只需一個簡單的 git push，即可在幾秒鐘內部署您的應用程式。

使用您自己的域名，並享受 HTTPS 證書的自動配置以增強安全性。

享受自動備份、一鍵更新，以及簡單、透明且可預測的定價，讓您安心無憂。

憑藉專用的私人 VM，獲得最佳的性能和強大的安全性。

節省時間並簡化您的生活：只需 5 分鐘即可嘗試 Stackhero 的 Ruby cloud hosting 解決方案！

GitHub Actions 讓您可以輕鬆自動化像是將 Ruby 程式碼部署到生產伺服器等任務，無需手動操作。

在本指南中，您將學會如何安全且可靠地設定 GitHub Actions，讓您的 Ruby 程式碼能自動部署到 staging（測試）與 production（生產）環境。這種方式能確保部署流程一致，並降低出錯風險。

首先，您需要在 GitHub 儲存庫中使用兩個分支：staging 與 production。每當您將程式碼推送到這兩個分支時，變更就會自動部署到對應的 Stackhero 實例。

擁有 staging 實例並非強制，但強烈建議同時建立 staging 與 production 環境。這是業界最佳實踐，有助於在問題進入生產環境前先行發現。

開始前，請確保您已擁有 GitHub 帳號，以及一個包含 Ruby 程式碼的儲存庫。

建立 Ruby 服務

請前往 Stackhero 控制台，建立兩個 Ruby 服務：一個用於 staging，一個用於 production。為了方便辨識，建議將這兩個服務分別重新命名為「Production」與「Staging」。

還沒有 Stackhero 帳號嗎？您可以在幾分鐘內免費註冊，然後只需幾個步驟即可建立您的 Ruby 雲端服務。

Production 與 Staging 服務範例

設定 SSH 金鑰

為了讓 GitHub Actions 能部署您的程式碼，您需要設定 SSH 金鑰。這樣可確保只有授權的操作能連線到您的 Stackhero 服務，保障部署安全。

您可以在本機產生一組新的 SSH 金鑰：

ssh-keygen -C "" -f /tmp/ssh_key -N ""

設定公鑰

接著，取得剛剛產生的公鑰內容：

cat /tmp/ssh_key.pub

在 Stackhero 控制台中，選擇您的「production」Ruby 服務並點擊「Configure」按鈕。取得服務設定

然後：

在 SSH public keys 下方，點擊 Add a public key。
在 Description 欄位輸入 GitHub Action。
在 Key 欄位貼上您電腦上的公鑰內容。

取得服務設定

設定私鑰

現在，請前往 GitHub 網站並打開您的專案。

進入 Settings > Environments，然後點擊 New environment。設定 GitHub 環境

將環境命名為「production」並儲存。設定環境名稱

點擊 No restriction 按鈕，選擇 Selected branches and tags。設定環境限制

點擊 Add deployment branch or tag rule，輸入「production」作為規則，然後新增。設定環境分支設定環境分支

為了安全儲存您的 SSH 私鑰，請到 Environment secrets 並點擊 Add secret。新增 secret

從您的電腦取得私鑰內容：

cat /tmp/ssh_key

在 Name 欄位輸入 STACKHERO_SSH_PRIVATE_KEY，在 Value 欄位貼上您的私鑰內容。設定 SSH 私鑰 secret

接下來，將 Ruby 服務的 endpoint 加入為環境變數。在 Environment variables 點擊 Add variable。設定變數

在 Name 輸入 STACKHERO_ENDPOINT，在 Value 貼上您在 Stackhero 控制台查詢到的 Ruby 服務 endpoint。設定 endpoint 變數

如果您已為服務設定自訂網域名稱，請務必使用該自訂網域，而非 <XXXXXX>.stackhero-network.com。

刪除產生的金鑰

當您已在 Stackhero 與 GitHub 完成金鑰設定後，為了安全起見，請將本機上的金鑰檔案刪除。

rm /tmp/ssh_key /tmp/ssh_key.pub

設定 GitHub Actions 工作流程

在您的本機 Git 儲存庫中，建立一個名為 .github/workflows 的資料夾，並在其中建立一個名為 deploy-to-stackhero.yml 的檔案。

# File: .github/workflows/deploy-to-stackhero.yml

name: Deploy to Stackhero
run-name: Deploy branch "${{ github.ref_name }}" to Stackhero

on:
  push:
    # List of branches that will trigger the deploy action following a git push.
    # Do not forget to create an environment corresponding to the branch name in GitHub (in "Settings"/"Environments").
    # Then add the corresponding secret "STACKHERO_SSH_PRIVATE_KEY" and variable "STACKHERO_ENDPOINT" in this environment.
    branches: [ "production", "staging" ]

jobs:
  Deploy:
    environment: ${{ github.ref_name }}
    runs-on: ubuntu-latest
    steps:
    - uses: stackhero-io/github-actions-deploy-to-stackhero@v1
      with:
        # The secret "STACKHERO_SSH_PRIVATE_KEY" and the variable "STACKHERO_ENDPOINT" should be defined in the corresponding branch environment on GitHub under "Settings"/"Environments".
        ssh_private_key: ${{ secrets.STACKHERO_SSH_PRIVATE_KEY }}
        endpoint: ${{ vars.STACKHERO_ENDPOINT }}

建立好 workflow 檔案後，您可以提交變更。

git add -A .
git commit -m "Add GitHub Actions to deploy to Stackhero"

接著，建立 production 分支。

git checkout -b production

最後，將變更推送到 GitHub。

git push --set-upstream origin production

這個 git push 指令會將您的程式碼上傳到 GitHub 的 production 分支。GitHub Actions 會自動啟動並將您的程式碼部署到 Stackhero 實例。

若要查看 workflow 執行情形，請前往專案的 GitHub 頁面並點擊 Actions。 GitHub Actions 已部署至 production

恭喜您，已成功利用 GitHub Actions 建立自動部署至 production 的流程。

建立 staging 環境

staging 環境的設定流程與 production 完全相同。只需將上述步驟中的 production 替換為 staging 即可。

完成 staging 環境設定後，您可以建立 staging 分支。

git checkout -b staging

將 staging 分支推送到 GitHub。

git push --set-upstream origin staging

GitHub Actions 現在會自動將 staging 分支部署到您指定的 Stackhero Ruby 實例。

進階建議

為了提升部署安全性，建議您保護 production 與 staging 分支。這代表禁止直接 push，所有變更都必須透過 pull request。具備適當權限的團隊成員可以審查並核准對 staging 的 pull request，確認無誤後再以相同方式合併到 production。

遵循這樣的 workflow，您可以提升安全性（僅授權使用者能部署到 staging 與 production），並增進可靠性（所有新功能都會先在 staging 測試後才進入 production）。這有助於確保部署流程順暢，並維持生產環境的穩定性。