在 GitHub 中管理秘密

已完成

秘密是您在組織、存放庫或存放庫環境中建立的變數。 秘密可用於 GitHub Actions 工作流程。 如果您明確將秘密包含在工作流程中,GitHub Actions 只能讀取秘密。

對於儲存在組織層級的秘密,您可以使用存取原則來控制哪些存放庫可以使用組織秘密。 組織層級的祕密可讓您在多個存放庫之間共用祕密。 這可減少建立重複秘密的需求。 在一個位置更新組織密碼也可確保變更會在使用該秘密的所有存放庫工作流程中生效。

對於儲存在環境層級的秘密,您可以讓必要的檢閱者控制秘密的存取權。 除非經過必要的核准者核准,否則工作流程作業無法存取環境秘密。

備註

您可以將工作流程設定為直接向 Azure 進行驗證,以存取資源。

為您的祕密命名

下列規則適用於秘密名稱:

  • 名稱只能包含英數位元 ([a-z]、 [A-Z][0-9]、 ) 或底線 (_)。 不允許空格。
  • 名稱不得以前綴 GITHUB_ 開頭。
  • 名稱不得以數字開頭。
  • 名稱不區分大小寫。
  • 名稱在建立的層級上必須是唯一的。

為了協助確保 GitHub 在記錄中修訂您的秘密,請避免使用結構化數據作為秘密的值。 例如,請避免建立包含 JSON 或編碼 Git blob 的機密資訊。

存取您的機密

將秘密設定為工作流程檔案中的輸入或環境變數,使其可供動作使用。 如果您有編輯檔案的存取權,則可以在工作流程檔案中使用和讀取秘密。 如需詳細資訊,請流覽 GitHub 上的訪問許可權。

當工作流程執行排入佇列時,系統會讀取組織和存放庫祕密,而當參考環境的工作啟動時,就會讀取環境祕密。 您也可以使用 REST API 管理秘密。

限制認證許可權

建議授與可能的最低許可權。 例如,使用部署密鑰或服務帳戶,而不是使用個人認證。 請考慮視需要授與唯讀許可權,並盡可能限制存取權。

產生個人存取令牌 (傳統) 時,請選取所需的最少範圍。 在生成細緻的個人存取令牌時,請選擇所需的最低權限和存放庫訪問權限。

建立祕密

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

秘密可以透過以下方法創造:

  • 選取存放庫頂端導覽列中的 [ 設定 ]。
  • 在左側導覽的 [ 安全性] 區段中,選取 [ 秘密和變數 ] 下拉式清單。
  • 選取 [動作 ] 以存取 [ 動作秘密和變數 ] 頁面。

在工作流程中使用秘密

若要將秘密作為輸入或環境變數提供給操作,您可以使用 secrets 環境來存取存放庫中建立的秘密。 下列程式代碼顯示存取工作流程中秘密的範例。

steps:
  - name: Hello world action
    with: # Set the secret as an input
      super_secret: ${{ secrets.SuperSecret }}
    env: # Or as an environment variable
      super_secret: ${{ secrets.SuperSecret }}

在 if: 條件式中無法直接引用機密。 請考慮將秘密設定為作業層級環境變數,然後參考環境變數,以有條件地在作業中執行步驟。

如果未設定秘密的值,則參考秘密的表達式傳回值(例如 ${{ secrets.SuperSecret }} 在範例中)是空字串。