Docker: 設定 GitHub Actions workflow

此文件屬於使用 GitHub Actions 部署指南的一部分。請在此處查看完整指南:學習如何利用 GitHub Actions 部署您的 Docker 容器

歡迎瀏覽 Stackhero 文件

Stackhero 提供即用型 Docker cloud CaaS (Containers as a Service) 平台,專為快速及可靠的 container 部署而設:

  • 只需一條 docker-compose up 指令即可部署到生產環境。無需額外設定:直接啟動您的 containers。
  • 可自訂您的網域名稱,並自動以 HTTPS 保護(例如:https://api.your-company.comhttps://www.your-company.comhttps://backoffice.your-company.com)。
  • 享有高效能及強大安全性的專屬私有基礎設施。
  • 一鍵套用更新,簡化維護工作,減少管理負擔。

您的 containers 約五分鐘內即可投入生產運作。Stackhero 會為您管理基礎設施、更新及安全,讓您專注於應用程式開發。了解更多 Docker CaaS cloud hosting 的詳情。

在本機,進入您的 Git repository,建立一個 .github/workflows 目錄。在此目錄下建立一個名為 deploy-to-stackhero.yml 的檔案,內容如下:

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

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

on:
  push:
    # 這些分支在 push 時會觸發部署動作。
    # 請確保在 GitHub(Settings > Environments)建立與分支名稱相符的環境。
    # 並在該環境中新增密鑰 STACKHERO_CERTIFICATES_PASSWORD 及變數 STACKHERO_ENDPOINT。
    branches: [ "production", "staging" ]

jobs:
  Deploy:
    environment: ${{ github.ref_name }}
    runs-on: ubuntu-latest
    steps:
    - uses: stackhero-io/github-actions-deploy-docker-containers-to-stackhero@v1
      with:
        # 密鑰 STACKHERO_CERTIFICATES_PASSWORD 及變數 STACKHERO_ENDPOINT 應在對應分支的 GitHub 環境中設定。
        certificates_password: ${{ secrets.STACKHERO_CERTIFICATES_PASSWORD }}
        endpoint: ${{ vars.STACKHERO_ENDPOINT }}
        # deployment_command 為選用項目。如需自訂 Docker Compose 指令可使用。
        deployment_command: ${{ vars.STACKHERO_DEPLOY_COMMAND }}

您可以用以下指令提交變更:

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

若要建立 production 分支,請執行:

git checkout -b production

然後將 production 分支推送到 GitHub:

git push --set-upstream origin production

當您的程式碼推送後,GitHub Actions 會自動將其部署到您的 production Stackhero 實例。您可以在 GitHub 專案的 Actions 分頁監察部署進度。

GitHub Actions 已部署到 productionGitHub Actions 已部署到 production

就是這麼簡單。您現在已設定好利用 GitHub Actions 自動部署程式碼到生產環境。