プロジェクトの値と変数
このページでは、CircleCI プロジェクトで使用できる定義済みの値について説明します。
定義済み環境変数
下記の定義済み環境変数は、すべての CircleCI プロジェクトで使用できます。 環境変数はジョブレベルで設定されます。 一つのジョブのコンテキスト内では使用できますが、パイプラインレベルでは存在しないため、パイプラインレベルまたはワークフローレベルのロジックには使用できません。
環境変数はジョブレベルで設定されます。 一つのジョブのコンテキスト内では使用できますが、パイプラインレベルでは存在しないため、パイプラインレベルまたはワークフローレベルのロジックには使用できません。
注: 定義済み環境変数を使用して別の環境変数を定義することはできません。 代わりに、run`ステップを使用して、新しい環境変数を `BASH_ENV でエクスポートする必要があります。 詳しくは シェルコマンドで環境変数を設定するをご覧ください。 |
Variable | VCS | Type | Value |
---|---|---|---|
| GitHub, Bitbucket, GitLab | Boolean |
|
| GitHub, Bitbucket, GitLab | Boolean |
|
| GitHub, Bitbucket, GitLab | String | The name of the Git branch currently being built. |
| GitHub, Bitbucket, GitLab | Integer | The number of the current job. Job numbers are unique for each job. |
| GitHub, Bitbucket, GitLab | String | The URL for the current job on CircleCI. |
| GitHub, Bitbucket, GitLab | String | The name of the current job. |
| GitHub, Bitbucket, GitLab | Integer | For jobs that run with parallelism enabled, this is the index of the current parallel run. The value ranges from 0 to ( |
| GitHub, Bitbucket, GitLab | Integer | For jobs that run with parallelism enabled, this is the number of parallel runs. This is equivalent to the value of |
| GitHub, Bitbucket, GitLab | String | An OpenID Connect token signed by CircleCI which includes details about the current job. |
| GitHub, Bitbucket, GitLab | String | An OpenID Connect token signed by CircleCI which includes details about the current job. |
| GitHub, Bitbucket | Integer | The number of the associated GitHub or Bitbucket pull request. Only available on forked PRs. |
| GitHub, Bitbucket | String | The name of the GitHub or Bitbucket repository where the pull request was created. Only available on forked PRs. |
| GitHub, Bitbucket | String | The GitHub or Bitbucket username of the user who created the pull request. Only available on forked PRs. |
| GitHub, Bitbucket, GitLab | Integer | The largest job number in a given branch that is less than the current job number. Note: The variable is not always set, and is not deterministic. It is also not set on runner executors. This variable is likely to be deprecated, and CircleCI recommends users to avoid using it. |
| GitHub, Bitbucket | String | The name of the repository of the current project. |
| GitHub, Bitbucket | String | The GitHub or Bitbucket username of the current project. |
| GitHub, Bitbucket | String | The URL of the associated pull request. If there are multiple associated pull requests, one URL is randomly chosen. |
| GitHub, Bitbucket | List | Comma-separated list of URLs of the current build’s associated pull requests. |
| GitHub, Bitbucket | String | The URL of your GitHub or Bitbucket repository. |
| GitHub, Bitbucket | String | The SHA1 hash of the last commit of the current build. |
| GitHub, Bitbucket | String | The name of the git tag, if the current build is tagged. For more information, see the Git Tag Job Execution section of the Workflows page. |
| GitHub, Bitbucket, GitLab | String | The GitHub or Bitbucket username of the user who triggered the pipeline (only if the user has a CircleCI account). |
| GitHub, Bitbucket, GitLab | String | A unique identifier for the workflow instance of the current job. This identifier is the same for every job in a given workflow instance. |
| GitHub, Bitbucket, GitLab | String | A unique identifier for the current job. |
| GitHub, Bitbucket, GitLab | String | An identifier for the workspace of the current job. This identifier is the same for every job in a given workflow. |
| GitHub, Bitbucket, GitLab | String | The value of the |
| GitHub, Bitbucket, GitLab | String | Internal. A directory where internal data related to the job is stored. We do not document the contents of this directory; the data schema is subject to change. |
If you must use the environment variables that are deprecated for GitLab SaaS in your GitLab pipelines, you can recreate this functionality using pipeline values in your configuration file. The following example shows how to set an environment variable CIRCLE_PROJECT_REPONAME
using the environment
key and populating it with the pipeline.trigger_parameters.gitlab.repo_name
value:
build:
docker:
- image: cimg/node:17.0
auth:
username: mydockerhub-user
password: $DOCKERHUB_PASSWORD # context / project UI env-var reference
environment:
CIRCLE_PROJECT_REPONAME: << pipeline.trigger_parameters.gitlab.repo_name >>
steps:
- run: echo $CIRCLE_PROJECT_REPONAME
パイプライン値
パイプライン値は、すべてのパイプライン設定で事前に宣言することなく使用できます。 パイプライン値はパイプラインレベルで設定されます。 ワークフローやジョブの実行時ではなく、コンパイル時に挿入されます。
Variable | VCS | Type | Value |
---|---|---|---|
| GitHub, Bitbucket | String | A globally unique id representing for the pipeline. |
| GitHub, Bitbucket | Integer | A project unique integer id for the pipeline. |
| GitHub, Bitbucket | String | The URL where the current project is hosted. For example, |
| GitHub, Bitbucket | String | The lower-case name of the VCS provider, for example, “github”, “bitbucket”. |
| GitHub, Bitbucket | String | The name of the git tag that was pushed to trigger the pipeline. If the pipeline was not triggered by a tag, then this is the empty string. |
| GitHub, Bitbucket | String | The name of the git branch that was pushed to trigger the pipeline. |
| GitHub, Bitbucket | String | The long (40-character) git SHA that is being built. |
| GitHub, Bitbucket | String | The long (40-character) git SHA of the build prior to the one being built. Note: While in most cases |
| GitHub, Bitbucket | Boolean | True if the pipeline is in the setup phase, for example, running a setup workflow. |
| GitHub, Bitbucket | String | The source that triggers the pipeline, current values are |
| GitHub, Bitbucket | String | The name of the schedule if it is a scheduled pipeline. Value will be empty string if the pipeline is triggered by other sources. |
| GitHub, Bitbucket | String | The unique id of the schedule if it is a scheduled pipeline. Value will be empty string if the pipeline is triggered by other sources. |
| GitLab | ID of the trigger that received the event | |
| GitLab | ID for the configuration source | |
| GitLab | GitLab | |
| GitLab | Timestamp CircleCI received the event | |
| GitLab | Push, pull request, manual, etc. | |
| GitLab | CircleCI project ID | |
| GitLab | CircleCI user ID | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. | |
| GitLab | See Gitlab documentation for webhooks and webhook events. |
たとえば以下のようになります。
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.