建置環境中的環境變數 - AWS CodeBuild

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

建置環境中的環境變數

AWS CodeBuild 提供多種環境變數，可讓您在組建命令中使用：

AWS_DEFAULT_REGION

執行組建的AWS區域 (例如us-east-1)。此環境變數主要由 AWS CLI 使用。

AWS_REGION

執行組建的AWS區域 (例如us-east-1)。此環境變數主要由 AWS 軟體開發套件使用。

代碼生成批處理構建標識符

批次建置中組建的識別碼。這在批處理構建規格中指定。如需詳細資訊，請參閱Batch 量生成構建規範參考。

程式碼建置程式碼

建置的 Amazon Resource Name () (ARNarn:aws:codebuild:region-ID:account-ID:build/codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE)。

程式碼建置 ID

組建的CodeBuild識別碼 (例如，codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE)。

程式碼建置映像檔

組CodeBuild建映像檔識別碼 (例如，aws/codebuild/standard:2.0)。

程式碼建置編號

專案的建置。

程式碼建置成功

目前的組建是否成功。設定為 0 表示建置失敗；設定為 1 表示建置成功。

程式碼建置啟動器

啟動組建的實體。如果是由 CodePipeline 開始建置，則此為管道的名稱 (例如 codepipeline/my-demo-pipeline)。如果使用者啟動組建，這就是使用者的名稱 (例如MyUserName)。如果是由 CodeBuild 的 Jenkins 外掛程式開始建置，則此為 CodeBuild-Jenkins-Plugin 字串。

程式碼建置程式碼

用來加密組建輸出成品的AWS KMS金鑰識別碼 (例如，arn:aws:kms:region-ID:account-ID:key/key-ID或alias/key-alias)。CodeBuild

代碼生成日誌路徑

組建的CloudWatch記錄檔資料流名稱。

代碼生成器公共構建網址

在公共構建網站上此版本的構建結果的 URL。只有在建置專案已啟用公開組建時，才會設定此變數。如需詳細資訊，請參閱中的公共組建專案AWS CodeBuild。

程式碼建置 _ 解析來源版本

組建原始程式碼的版本識別碼。內容取決於源代碼存儲庫：

CodeCommit,GitHub,GitHub 企業伺服器和比特桶

此變數包含提交 ID。

CodePipeline

此變數包含由提供的來源修訂版本CodePipeline。

如果CodePipeline無法解析來源修訂，例如來源是未啟用版本控制的 Amazon S3 儲存貯體，則不會設定此環境變數。

Amazon S3

未設定此變數。

如果適用，CODEBUILD_RESOLVED_SOURCE_VERSION變數只能在DOWNLOAD_SOURCE階段之後使用。

程式碼建置來源網址

輸入成品或原始程式碼儲存庫的 URL。對於 Amazon S3，s3://其後是存儲桶名稱和輸入成品的路徑。對於CodeCommit和GitHub，這是存放庫的複製 URL。如果構建源於CodePipeline，則此環境變量可能是空的。

對於次要來源，次要來源存放庫 URL 的環境變數為CODEBUILD_SOURCE_REPO_URL_<sourceIdentifier>，其中<sourceIdentifier>是您建立的來源識別碼。

程式碼建置來源版本

值的格式取決於來源儲存庫。

  • 對於 Amazon S3，它是與輸入成品相關聯的版本識別碼。

  • 對於 CodeCommit，它是與要建置的來源碼版本相關聯的遞交 ID 或分支名稱。

  • 針對GitHubGitHub，為遞交 ID、和 Bitbucket，或與您想要建置之原始程式碼版本關聯的標籤名稱。

    注意

    對於由 webhook 提取請求事件觸發的GitHub或GitHub企業服務器構建，它是pr/pull-request-number。

對於次要來源，次要來源版本的環境變數為CODEBUILD_SOURCE_VERSION_<sourceIdentifier>，其中<sourceIdentifier>是您建立的來源識別元。如需詳細資訊，請參閱多個輸入來源和輸出成品範例。

程式碼建置程式碼 _ 目錄

CodeBuild用於組建的目錄路徑 (例如，/tmp/src123456789/src)。

對於次要來源，次要來源目錄路徑的環境變數為CODEBUILD_SRC_DIR_<sourceIdentifier>，其中<sourceIdentifier>是您建立的來源識別碼。如需詳細資訊，請參閱多個輸入來源和輸出成品範例。

程式碼建置啟動時間

指定為 Unix 時間戳記的構建的開始時間，以毫秒為單位。

代碼生成 _ 網絡掛鉤 _ 帳戶 ID

觸發 webhook 事件之使用者的帳戶識別碼。

代碼生成 _ 網絡掛鉤 _ 基礎 _ 參考

觸發當前構建的 webhook 事件的基本引用名稱。對於提取請求，這是分支參考。

代碼生成網絡掛鉤事件

觸發當前構建的 webhook 事件。

代碼生成 _ 合併 _ 提交

用於構建的合併提交的標識符。當 Bitbucket 提取請求與壁球策略合併並且拉取請求分支被關閉時設置此變量。在這種情況下，原始的提取請求提交不再存在，因此此環境變量包含壓縮合併提交的標識符。

代碼生成器提交網絡掛鉤

觸發當前構建的 webhook 推送事件之前的最新提交的 ID。

代碼生成 _ 網絡掛鉤 _ 引用

觸發當前構建的 webhook 事件的頭引用名稱。它可以是分支參考或標籤參考。

程式碼建置 _ 網頁掛鉤觸發器

顯示觸發組建的 Webhook 事件。此變數僅適用 Webhook 觸發的建置。該值是從發送到GitHub，GitHub企業服務器或 BitbucketCodeBuild 的有效負載進行解析。該值的格式取決於觸發建置的事件類型。

  • 對於提取請求觸發的建置，它是 pr/pull-request-number。

  • 對於建立新分支或將遞交推送至分支而觸發的建置，它是 branch/branch-name。

  • 對於將標籤推送到儲存庫而觸發的建置，它是 tag/tag-name。

家

此環境變數一律設定為/root。

您也可以為建置環境提供您自己的環境變數。如需詳細資訊，請參閱下列主題：

若要列出建置環境中所有可用的環境變數，您可以在建置期間執行 printenv 命令 (適用於 Linux 建置環境) 或 "Get-ChildItem Env:" (適用於 Windows 建置環境)。除了上方列出的例外，以 CODEBUILD_ 開頭的環境變數僅供 CodeBuild 內部使用。因此，您不應將它們用在建置命令中。

重要

我們強烈建議使用環境變數來儲存敏感值，特別是AWS存取金鑰 ID。您可以使用 CodeBuild 主控台和 AWS CLI 等工具，以純文字顯示環境變數。

我們建議您將敏感值存放在 Amazon EC2 Systems Manager 參數存放區，然後從您的組建規格擷取這些值。若要存放機密值，請參閱 Amazon EC2 Systems Manager 使用者指南中的系統管理員參數存放區和逐步解說：建立和測試字串參數 (主控台)。若要擷取這些值，請參閱 Buildspec 語法 中的 parameter-store 映射。