ドキュメント
circleci.com
Start Building for Free

プロジェクトの値と変数

3 weeks ago1 min read
クラウド
Server v3.x
Server v2.x
On This Page
  • 定義済み環境変数
  • パイプライン値

このページでは、CircleCI プロジェクトで使用できる定義済みの値について説明します。

定義済み環境変数

下記の定義済み環境変数は、すべての CircleCI プロジェクトで使用できます。 環境変数はジョブレベルで設定されます。 環境変数は 1 つのジョブのコンテキスト内では使用できますが、パイプラインレベルでは存在しないため、パイプラインレベルまたはワークフローレベルのロジックには使用できません。

注: 定義済み環境変数を使用して別の環境変数を定義することはできません。 代わりに、run ステップを使用して、新しい環境変数を BASH_ENV でエクスポートする必要があります。 詳しくは シェルコマンドで環境変数を設定するをご覧ください。

変数タイプ
CIブール値型true (現在の環境が CI 環境かどうかを表します)
CIRCLECIブール値型true (現在の環境が CircleCI 環境かどうかを表します)。
CIRCLE_BRANCH文字列型現在ビルド中の Git ブランチの名前。
CIRCLE_BUILD_NUM整数型現在のジョブの番号。 この番号はジョブごとに一意です。
CIRCLE_BUILD_URL文字列型CircleCI での現在のジョブの URL
CIRCLE_JOB文字列型現在のジョブの名前。
CIRCLE_NODE_INDEX整数型(並列実行を有効化してジョブを実行する場合) 並列実行の現在のインデックスです。 0 から “CIRCLE_NODE_TOTAL - 1” までの値を取ります。
CIRCLE_NODE_TOTAL整数型(並列実行を有効化してジョブを実行する場合) 並列実行の総数です。 設定ファイルの parallelism の値と等しくなります。
CIRCLE_OIDC_TOKEN文字列型CircleCI が署名した OpenID Connect トークン。現在のジョブの詳細情報を含みます。 コンテキストを使用しているジョブで使用可能です。
CIRCLE_PR_NUMBER整数型関連付けられた GitHub または Bitbucket プル リクエストの番号。 フォークしたプルリクエストのみで使用可能です。
CIRCLE_PR_REPONAME文字列型プル リクエストが作成された GitHub または Bitbucket リポジトリの名前。 フォークしたプルリクエストのみで使用可能です。
CIRCLE_PR_USERNAME文字列型プル リクエストを作成したユーザーの GitHub または Bitbucket ユーザー名。 フォークしたプルリクエストのみで使用可能です。
CIRCLE_PREVIOUS_BUILD_NUM整数型任意のブランチで現在のジョブ番号よりも小さい最大のジョブ番号です。 : 変数は常に設定されるわけではなく、決定論的ではありません。 ランナー Executor には設定されません。 この変数は廃止予定であり、使用を避けることをお勧めします。
CIRCLE_PROJECT_REPONAME文字列型現在のプロジェクトのリポジトリの名前。
CIRCLE_PROJECT_USERNAME文字列型現在のプロジェクトの GitHub または Bitbucket ユーザー名。
CIRCLE_PULL_REQUEST文字列型関連付けられたプル リクエストの URL。 ひも付けられたプルリクエストが複数ある時は、そのうちの 1 つがランダムで選ばれます。
CIRCLE_PULL_REQUESTSリスト現在のビルドに関連付けられたプル リクエストの URL の一覧 (カンマ区切り)。
CIRCLE_REPOSITORY_URL文字列型GitHub または Bitbucket リポジトリ URL。
CIRCLE_SHA1文字列型現在のビルドの前回のコミットの SHA1 ハッシュ。
CIRCLE_TAG文字列型git タグの名前 (現在のビルドがタグ付けされている場合)。 詳しくは Git タグを使ったジョブの実行を参照してください。
CIRCLE_USERNAME文字列型パイプラインをトリガーしたユーザーの GitHub または Bitbucket ユーザー名 (そのユーザーが CircleCI のアカウントを持っている場合のみ)
CIRCLE_WORKFLOW_ID文字列型現在のジョブのワークフロー インスタンスの一意の識別子。 この ID は Workflow インスタンス内のすべてのジョブで同一となります。
CIRCLE_WORKFLOW_JOB_ID文字列型現在のジョブの一意の識別子。
CIRCLE_WORKFLOW_WORKSPACE_ID文字列型現在のジョブの ワークスペースの識別子。 この識別子は、特定のワークスペース内のすべてのジョブで同じです。
CIRCLE_WORKING_DIRECTORY文字列型現在のジョブの working_directory キーの値。
CIRCLE_INTERNAL_TASK_DATA文字列型内部用。 ジョブ関連の内部データが格納されるディレクトリ。 データ スキーマは変更される可能性があるため、このディレクトリのコンテンツは文書化されていません。

パイプライン値

パイプライン値は、すべてのパイプライン設定で事前に宣言することなく使用できます。 パイプライン値はパイプラインレベルで設定されます。 ワークフローやジョブの実行時ではなく、コンパイル時に挿入されます。

変数タイプ
pipeline.id文字列型パイプラインを表す、 グローバルに一意のID
pipeline.number整数型パイプラインを表す、プロジェクトで一意の整数の ID
pipeline.project.git_url文字列型現在のプロジェクトがホストされている URL 。 たとえば、https://github.com/circleci/circleci-docs
pipeline.project.type文字列型小文字の VCS プロバイダ名。 例: “github”、“bitbucket”
pipeline.git.tag文字列型パイプラインをトリガーするためにプッシュされた git タグの名前。 タグでトリガーされたパイプラインでない場合は、文字列は空です。
pipeline.git.branch文字列型パイプラインをトリガーするためにプッシュされた git タグの名前。
pipeline.git.revision文字列型現在ビルドしている長い git SHA(40文字)
pipeline.git.base_revision文字列型現在ビルドしているものより前のビルドの長い git SHA (40 文字) **注: ** 多くの場合、pipeline.git.base_revision は、現在実行しているパイプラインより前のパイプラインを実行する SHA ですが、いくつか注意事項があります。 ブランチの最初のビルドの場合、変数は表示されません。 また、ビルドが API からトリガーされた場合も変数は表示されません。
pipeline.in_setupブール値型パイプラインがセットアップ段階にある場合 ( セットアップ ワークフローの実行中など) は、有効です。
pipeline.trigger_source文字列型パイプラインをトリガーするソース、現在の値は webhookapischeduled_pipeline です。
pipeline.schedule.name文字列型パイプラインのスケジュール実行の場合はスケジュール名です。 他のソースがこのパイプラインをトリガーすると、値は空の文字列になります。
pipeline.schedule.id文字列型パイプラインのスケジュール実行の場合は当該スケジュールの一意の ID です。 他のソースがこのパイプラインをトリガーすると、値は空の文字列になります。

例えば下記のようにします。

version: 2.1

jobs:
  build:
    docker:
      - image: cimg/node:latest
        auth:
          username: mydockerhub-user
          password: $DOCKERHUB_PASSWORD  # context / project UI env-var reference
    environment:
      CIRCLE_COMPARE_URL: << pipeline.project.git_url >>/compare/<< pipeline.git.base_revision >>..<<pipeline.git.revision>>
    working_directory: ~/main
    steps:
      - run: echo "This is pipeline ID << pipeline.id >>"
      - run: echo $CIRCLE_COMPARE_URL

注: 上記の方法で environment キーの変数を設定する際にパイプラインの変数が空の場合、変数は <nil> が設定されます。 文字列を空にする必要がある場合は、 シェルコマンドで変数を設定するをご覧ください。


ドキュメントの改善にご協力ください

このガイドは、CircleCI の他のドキュメントと同様にオープンソースであり、 GitHub でご利用いただけます。 ご協力いただき、ありがとうございます。

サポートが必要ですか

CircleCI のサポートエンジニアによる、サービスに関する問題、請求およびアカウントについての質問への対応、設定の構築に関する問題解決のサポートを行っています。 サポートチケットを送信して、CircleCI のサポートエンジニアにお問い合わせください。日本語でお問い合わせいただけます。

または、 サポートサイト から、サポート記事やコミュニティフォーラム、トレーニングリソースをご覧いただけます。