プロジェクトの値と変数
Last updated • Reading time
クラウド Server v3.x Server v2.x このページでは、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 | 文字列型 | 内部用。 ジョブ関連の内部データが格納されるディレクトリ。 データ スキーマは変更される可能性があるため、このディレクトリのコンテンツは文書化されていません。 |
CIRCLE_COMPARE_URL | 文字列型 | 非推奨。 同じビルドのコミットどうしを比較するための GitHub または Bitbucket URL。 v2 以下の設定ファイルで使用可能です。 v2.1 では、この変数に代わり “パイプライン値” が導入されています。 |
パイプライン値
パイプライン値は、すべてのパイプライン設定で事前に宣言することなく使用できます。 パイプライン値はパイプラインレベルで設定されます。 ワークフローやジョブの実行時ではなく、コンパイル時に挿入されます。
| 変数 | タイプ | 値 |
|---|---|---|
pipeline.id | 文字列型 | パイプラインを表す、グローバルに一意のID。 |
pipeline.number | 整数型 | パイプラインを表す、プロジェクトで一意の整数の ID |
pipeline.project.git_url | 文字列型 | 現在のプロジェクトがホストされている URL 。 For example, 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（４０文字） |
pipeline.git.base_revision | 文字列型 | 現在ビルドしているものより前のビルドの長い git SHA （４０文字） Note: While in most cases pipeline.git.base_revision will be the SHA of the pipeline that ran before your currently running pipeline, there are some caveats. ブランチの最初のビルドの場合、変数は表示されません。 また、ビルドが API からトリガーされた場合も変数は表示されません。 |
pipeline.in_setup | ブール値型 | True if the pipeline is in the setup phase, i.e. running a setup workflow. |
pipeline.trigger_source | 文字列型 | The source that triggers the pipeline, current values are webhook, api, scheduled_pipeline
|
pipeline.schedule.name | 文字列型 | The name of the schedule if it is a scheduled pipeline. Value will be empty string if the pipeline is triggerd by other sources |
pipeline.schedule.id | 文字列型 | The unique id of the schedule if it is a scheduled pipeline. Value will be empty string if the pipeline is triggerd by other sources |
例えば下記のようにします。
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 でご利用いただけます。 ご協力いただき、ありがとうございます。
- このページの編集をご提案ください (最初に「コントリビューションガイド」をご覧ください)。
- ドキュメントの問題点を報告する、またはフィードバックやコメントを送信するには、GitHub で issue を作成してください。
- CircleCI は、ユーザーの皆様の弊社プラットフォームにおけるエクスペリエンスを向上させる方法を常に模索しています。 フィードバックをお寄せいただける場合は、リサーチコミュニティにご参加ください。
サポートが必要ですか？
CircleCI のサポートエンジニアによる、サービスに関する問題、請求およびアカウントについての質問への対応、設定の構築に関する問題解決のサポートを行っています。 サポートチケットを送信して、CircleCI のサポートエンジニアにお問い合わせください。日本語でお問い合わせいただけます。
または、サポートサイトから、サポート記事やコミュニティフォーラム、トレーニングリソースをご覧いただけます。
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
