在工作流程中實作變數和腳本

已完成

現在您已知道工作流程檔案的元件,讓我們探索如何針對各種案例自定義這些工作流程。 在此單元中,我們將著重於如何使用變數和腳本來優化工作流程。 變數提供儲存和重複使用不區分組態資訊的方式。 您可以將任何組態數據儲存,例如編譯程式旗標、使用者名稱或伺服器名稱儲存為變數。 變數會在執行工作流程的執行器電腦上插入。 在動作或工作流程步驟中執行的命令可以建立、讀取和修改變數。

您可以設定自己的自定義變數,或使用 GitHub 自動設定的預設環境變數。 您可以透過兩種方式建立自定義變數。

  • 若要定義可在單一工作流程中使用的環境變數,您可以在工作流程檔案中使用 env 索引鍵。
  • 若要跨多個工作流程定義組態變數,您可以在組織、存放庫或環境層級加以定義。

定義單一工作流程的環境變數

若要設定單一工作流程的自定義環境變數,您可以使用工作流程檔案中的 env 索引鍵來定義它。 這個方法所設定的自定義變數範圍僅限於其定義所在的元素。 您可以定義下列範圍的變數:

  • 整個工作流程,方法是在工作流程檔案的最上層使用 env。
  • 工作流程內作業的內容,方法是使用 jobs.<job_id>.env。
  • 作業內的特定步驟,方法是使用 jobs.<job_id>.steps[*].env。

備註

jobs.<job_id>.env 和 jobs.<job_id>.steps[*].env 都會實作稍後在本模組中涵蓋的情境。

下列工作流程範例會實作兩個變數,DAY_OF_WEEK 和 Greeting,以在執行時產生問候語。

name: Greeting on variable day

on:
  workflow_dispatch

env:
  DAY_OF_WEEK: Monday

jobs:
  greeting_job:
    runs-on: ubuntu-latest
    env:
      Greeting: Hello
    steps:
      - name: "Say Hello"
        run: echo "$Greeting, today is $DAY_OF_WEEK!"

環境變數的命名慣例

當您設定環境變數時,無法使用任何預設環境變數名稱。 如果您嘗試覆寫其中一個預設變數的值,該賦值將被忽略。

提示

若要查看預設環境變數的完整清單,請瀏覽 預設環境變數。

建立存放庫的組態變數

若要在 GitHub 上為個人帳戶存放庫建立秘密或變數,您必須是存放庫擁有者。 若要在 GitHub 上為組織存放庫建立秘密或變數,您必須具有 admin 存取權。 最後,若要透過 REST API 為個人帳戶存放庫或組織存放庫建立秘密或變數,您必須具有共同作業者存取權。

組態變數優先順序

如果具有相同名稱的變數存在於多個層級,則最低層級的變數會優先使用。 例如,如果組織層級變數的名稱與存放庫層級變數相同,則存放庫層級變數會優先使用。 同樣地,如果組織、存放庫和環境都有具有相同名稱的變數,則環境層級變數優先。

將腳本新增至您的工作流程

您可以使用 GitHub Actions 工作流程來執行指令碼和殼層命令,然後在指派的執行器上執行。 下列範例示範如何使用 run 關鍵詞,在執行器上執行命令 npm install -g bats。

jobs:
  example-job:
    runs-on: ubuntu-latest
    steps:
      - run: npm install -g bats

若要執行儲存在存放庫中的腳本,您必須先將存放庫簽出給執行器。 下列範例:檢出存放庫;設定工作目錄,即存放庫中的腳本位置;執行 my-script.sh 腳本。

jobs:
  example-job:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ./scripts
    steps:
      - name: Check out the repository to the runner
        uses: actions/checkout@v4  
      - name: Run a script
        run: ./my-script.sh

您希望工作流程作業執行的任何腳本都必須是可執行檔。 您可以將腳本當做自變數傳遞至執行腳本的解釋器,例如,run: bash script.sh ,或讓檔案本身成為可執行檔。