定義済み変数の参照
定義済みのCI/CD変数は、すべてのGitLab CI/CDパイプラインで利用可能です。
いくつかの変数はより新しいバージョンのGitLab Runnerでのみ利用可能です。
script
コマンドでジョブで利用可能なすべての変数の値を出力することができます。
また、ランナーの動作をグローバルまたは個々のジョブで設定するために使用できる変数も多数あります。
パイプラインが予期しない動作をする可能性があるので、定義済みの変数の上書きは避けるべきです。
変数 | GitLab | Runner | 説明 |
---|---|---|---|
CHAT_CHANNEL | 10.6 | すべて | ChatOpsコマンドをトリガーしたソースチャットチャンネル。 |
CHAT_INPUT | 10.6 | すべて | ChatOpsコマンドで渡される追加引数。 |
CHAT_USER_ID | 14.4 | すべて | ChatOpsコマンドをトリガーしたユーザーのチャットサービスのユーザーID。 |
CI | すべて | 0.4 | CI/CD で実行されるすべてのジョブで利用可能です。true 利用可能な場合。 |
CI_API_V4_URL | 11.7 | すべて | GitLab API v4 のルート URL。 |
CI_API_GRAPHQL_URL | 15.11 | すべて | GitLab API GraphQL ルート URL。 |
CI_BUILDS_DIR | すべて | 11.10 | ビルドが実行されるトップレベルのディレクトリ。 |
CI_COMMIT_AUTHOR | 13.11 | すべて |
Name <email> 形式でのコミット作成者。 |
CI_COMMIT_BEFORE_SHA | 11.2 | すべて | ブランチやタグに存在する、直前の最新コミット。マージリクエストパイプラインやブランチやタグのパイプラインの最初のコミットでは、常に0000000000000000000000000000000000000000 となります。 |
CI_COMMIT_BRANCH | 12.6 | 0.5 | コミットブランチ名。デフォルトブランチのパイプラインを含むブランチパイプラインで使用できます。マージリクエストパイプラインやタグパイプラインでは使用できません。 |
CI_COMMIT_DESCRIPTION | 10.8 | すべて | コミットの説明。タイトルが 100 文字より短い場合は、最初の行を除いたメッセージ。 |
CI_COMMIT_MESSAGE | 10.8 | すべて | コミットメッセージの全文です。 |
CI_COMMIT_REF_NAME | 9.0 | すべて | プロジェクトがビルドされるブランチ名またはタグ名。 |
CI_COMMIT_REF_PROTECTED | 11.11 | すべて |
true ジョブが保護された参照に対して実行されている場合はすべて、そうでない場合はfalse 。 |
CI_COMMIT_REF_SLUG | 9.0 | すべて |
CI_COMMIT_REF_NAME を小文字にし、63 バイトに短縮し、0-9 とa-z 以外を- . - NET に置き換えています。- 先頭/末尾の. - は使用しません。URL、ホスト名、ドメイン名で使用します。 |
CI_COMMIT_SHA | 9.0 | すべて | プロジェクトがビルドされるコミットリビジョン。 |
CI_COMMIT_SHORT_SHA | 11.7 | すべて |
CI_COMMIT_SHA の最初の8文字。 |
CI_COMMIT_TAG | 9.0 | 0.5 | コミットタグ名。タグのパイプラインでのみ使用できます。 |
CI_COMMIT_TAG_MESSAGE | 15.5 | すべて | コミットタグメッセージ。タグのパイプラインでのみ使用できます。 |
CI_COMMIT_TIMESTAMP | 13.4 | すべて | ISO 8601形式でのコミットのタイムスタンプ。 |
CI_COMMIT_TITLE | 10.8 | すべて | コミットのタイトル。メッセージの最初の行。 |
CI_CONCURRENT_ID | すべて | 11.10 | 1つのExecutorでビルドを実行する際の一意のIDです。 |
CI_CONCURRENT_PROJECT_ID | すべて | 11.10 | 単一のエクゼキュータとプロジェクトにおけるビルド実行の一意なID。 |
CI_CONFIG_PATH | 9.4 | 0.5 | CI/CD 設定ファイルへのパス。デフォルトは.gitlab-ci.yml 。実行中のパイプライン内では読み取り専用です。 |
CI_DEBUG_TRACE | すべて | 1.7 |
true デバッグロギング(トレース)が有効な場合。 |
CI_DEBUG_SERVICES | 15.7 | 15.7 |
true サービスコンテナのロギングが有効な場合。 |
CI_DEFAULT_BRANCH | 12.4 | すべて | プロジェクトのデフォルトブランチの名前。 |
CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX | 13.7 | すべて | 依存プロキシを通してイメージを取得するための、トップレベルのグループイメージプレフィックス。 |
CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX | 14.3 | すべて | 依存プロキシを通してイメージを取得するための、直接グループイメージのプレフィックス。 |
CI_DEPENDENCY_PROXY_PASSWORD | 13.7 | すべて | 依存プロキシを通してイメージをプルするためのパスワード。 |
CI_DEPENDENCY_PROXY_SERVER | 13.7 | すべて | 依存プロキシにログインするためのサーバ。これは$CI_SERVER_HOST:$CI_SERVER_PORT と同じです。 |
CI_DEPENDENCY_PROXY_USER | 13.7 | すべて | 依存プロキシを通して画像を取得するユーザ名。 |
CI_DEPLOY_FREEZE | 13.2 | すべて | パイプラインがデプロイフリーズウィンドウ中に実行された場合のみ使用できます。true 使用可能な場合。 |
CI_DEPLOY_PASSWORD | 10.8 | すべて | プロジェクトにGitLab デプロイトークンがある場合は、その認証パスワード。 |
CI_DEPLOY_USER | 10.8 | すべて | プロジェクトにGitLab デプロイトークンがある場合は、その認証ユーザー名。 |
CI_DISPOSABLE_ENVIRONMENT | すべて | 10.1 | ジョブが使い捨て環境(このジョブのためだけに作成され、実行後に廃棄/破棄されるもの。shell とssh を除くすべてのエクゼキュータ)で実行される場合にのみ利用可能です。true 利用可能な場合。 |
CI_ENVIRONMENT_NAME | 8.15 | すべて | このジョブの環境名。environment:name が設定されている場合に利用可能です。 |
CI_ENVIRONMENT_SLUG | 8.15 | すべて | DNS、URL、Kubernetesラベルなどに含めるのに適した環境名の簡略版。environment:name が設定されている場合に利用可能です。スラッグは24 文字に切り詰められます。大文字の環境名には、ランダムなサフィックスが自動的に追加されます。 |
CI_ENVIRONMENT_URL | 9.3 | すべて | このジョブの環境のURL。environment:url が設定されている場合に利用可能です。 |
CI_ENVIRONMENT_ACTION | 13.11 | すべて | このジョブの環境に指定されたアクション注釈。environment:action が設定されている場合に利用可能です。start ,prepare , またはstop を指定できます。 |
CI_ENVIRONMENT_TIER | 14.0 | すべて | このジョブの環境のデプロイ階層。 |
CI_RELEASE_DESCRIPTION | 15.5 | すべて | リリースの説明。タグのパイプラインでのみ利用可能です。説明文の長さは最初の 1024 文字に制限されています。 |
CI_GITLAB_FIPS_MODE | 14.10 | すべて | GitLabインスタンスでFIPSモードが有効になっている場合のみ利用可能。true 。 |
CI_HAS_OPEN_REQUIREMENTS | 13.1 | すべて | パイプラインのプロジェクトにオープン要件がある場合のみ利用できます。true 。 |
CI_JOB_ID | 9.0 | すべて | ジョブの内部 ID。GitLab インスタンスのすべてのジョブで一意です。 |
CI_JOB_IMAGE | 12.9 | 12.9 | ジョブを実行するDockerイメージの名前。 |
CI_JOB_JWT (非推奨) | 12.10 | すべて | HashiCorpのVaultなど、JWT認証をサポートするサードパーティシステムで認証するためのRS256 JSONウェブトークンです。GitLab 15.9で非推奨となり、GitLab 16.5で削除される予定です。代わりにIDトークンを使ってください。 |
CI_JOB_JWT_V1 (非推奨) | 14.6 | すべて |
CI_JOB_JWT と同じ値。GitLab 15.9で非推奨、GitLab 16.5で削除予定。代わりにIDトークンを使いましょう。 |
CI_JOB_JWT_V2 (非推奨) | 14.6 | すべて | 互換性を高めるために新しくフォーマットされた RS256 JSON ウェブトークン。CI_JOB_JWT と似ていますが、発行者(iss )のクレームがgitlab.com からhttps://gitlab.com に変更され、sub がjob_id からプロジェクトパスを含む文字列に変更され、aud クレームが aud 追加されています。aud フィールドは aud 定数値です。複数の依存者のJWTを信頼すると、あるRPが別のRPにJWTを送信し、ジョブとして悪意を持って行動する可能性があります。GitLab 15.9で非推奨となり、GitLab 16.5で削除される予定です。代わりにIDトークンを使いましょう。 |
CI_JOB_MANUAL | 8.12 | すべて | ジョブが手動で開始された場合のみ利用可能です。true 利用可能な場合。 |
CI_JOB_NAME | 9.0 | 0.5 | ジョブの名前。 |
CI_JOB_NAME_SLUG | 15.4 | すべて |
CI_JOB_NAME_SLUG を小文字にし、63 バイトに短縮し、0-9 とa-z 以外を- . - NET に置き換えています。- 先頭/末尾に . - パスで使用します。 |
CI_JOB_STAGE | 9.0 | 0.5 | ジョブのステージ名。 |
CI_JOB_STATUS | すべて | 13.5 | 各 Runner ステージが実行されるときのジョブのステータス。after_script と共に使用します。success ,failed , またはcanceled のいずれかです。 |
CI_JOB_TIMEOUT | 15.7 | 15.7 | ジョブのタイムアウトを秒単位で指定します。 |
CI_JOB_TOKEN | 9.0 | 1.2 | 特定のAPIエンドポイントで認証するためのトークン。このトークンはジョブが実行されている限り有効です。 |
CI_JOB_URL | 11.1 | 0.5 | ジョブの詳細URL。 |
CI_JOB_STARTED_AT | 13.10 | すべて | ジョブが開始されたUTC日時。ISO 8601形式。 |
CI_KUBERNETES_ACTIVE | 13.0 | すべて | パイプラインにデプロイ可能なKubernetesクラスターがある場合のみ利用可能です。true 利用可能な場合。 |
CI_NODE_INDEX | 11.5 | すべて | ジョブセット内のジョブのインデックス。ジョブがparallel を使用している場合のみ利用可能です。 |
CI_NODE_TOTAL | 11.5 | すべて | 並行して実行されているこのジョブのインスタンスの総数。ジョブがparallel を使用しない場合は1 に設定します。 |
CI_OPEN_MERGE_REQUESTS | 13.8 | すべて | 現在のブランチとプロジェクトをマージリクエストソースとして使用する、最大 4 つのマージリクエストをカンマ区切りで指定します。ブランチとマージリクエストパイプラインでは、ブランチに関連するマージリクエストがある場合のみ使用できます。たとえば、gitlab-org/gitlab!333,gitlab-org/gitlab-foss!11 . |
CI_PAGES_DOMAIN | 11.8 | すべて | GitLab Pagesをホストする設定済みのドメイン。 |
CI_PAGES_URL | 11.8 | すべて | GitLab PagesサイトのURL。常にCI_PAGES_DOMAIN のサブドメインです。 |
CI_PIPELINE_ID | 8.10 | すべて | 現在のパイプラインのインスタンスレベルのID。この ID は GitLab インスタンス上のすべてのプロジェクトで一意です。 |
CI_PIPELINE_IID | 11.0 | すべて | 現在のパイプラインのプロジェクトレベルのIID(内部ID)。このIDは、現在のプロジェクト内でのみ一意です。 |
CI_PIPELINE_SOURCE | 10.0 | すべて | パイプラインのトリガー方法。push ,web ,schedule ,api ,external ,chat ,webide ,merge_request_event ,external_pull_request_event ,parent_pipeline ,trigger , またはpipeline のいずれかです。各値の説明については、Commonif Cluses forrules を参照してください。この変数を使用して、ジョブの実行タイミングを制御します。 |
CI_PIPELINE_TRIGGERED | すべて | すべて |
true ジョブがトリガーされた場合。 |
CI_PIPELINE_URL | 11.1 | 0.5 | パイプラインの詳細のURL。 |
CI_PIPELINE_CREATED_AT | 13.10 | すべて | パイプラインが作成された UTC 時刻 (ISO 8601形式)。 |
CI_PIPELINE_NAME | 16.3 | すべて | で定義されたパイプライン名。workflow:name
|
CI_PROJECT_DIR | すべて | すべて | リポジトリがクローンされるフルパスと、ジョブが実行される場所。GitLab Runnerbuilds_dir パラメータが設定されている場合、この変数は . builds_dir GitLab Runner の詳細設定を参照してください。 |
CI_PROJECT_ID | すべて | すべて | 現在のプロジェクトのID。この ID は GitLab インスタンス上のすべてのプロジェクトで一意です。 |
CI_PROJECT_NAME | 8.10 | 0.5 | プロジェクトのディレクトリ名。例えば、プロジェクトの URL がgitlab.example.com/group-name/project-1 の場合、CI_PROJECT_NAME はproject-1 となります。 |
CI_PROJECT_NAMESPACE | 8.10 | 0.5 | ジョブのプロジェクトネームスペース (ユーザー名またはグループ名)。 |
CI_PROJECT_NAMESPACE_ID | 15.7 | 0.5 | ジョブのプロジェクトネームスペースID。 |
CI_PROJECT_PATH_SLUG | 9.3 | すべて |
$CI_PROJECT_PATH をすべて小文字にし、a-z または0-9 以外の文字は- に置き換え、63 バイトに短縮します。URLやドメイン名で使用します。 |
CI_PROJECT_PATH | 8.10 | 0.5 | プロジェクト名を含むプロジェクト・ネームスペース。 |
CI_PROJECT_REPOSITORY_LANGUAGES | 12.3 | すべて | リポジトリで使用されている言語をカンマ区切りの小文字で指定します。たとえばruby,javascript,html,css 。言語数の上限は 5 です。イシューはこの制限を増やすことを提案しています。 |
CI_PROJECT_ROOT_NAMESPACE | 13.2 | 0.5 | ジョブのルートプロジェクトの名前空間(ユーザー名またはグループ名)。例えば、CI_PROJECT_NAMESPACE がroot-group/child-group/grandchild-group の場合、CI_PROJECT_ROOT_NAMESPACE はroot-group です。 |
CI_PROJECT_TITLE | 12.4 | すべて | GitLab ウェブインタフェースに表示される、人間が読めるプロジェクト名。 |
CI_PROJECT_DESCRIPTION | 15.1 | すべて | GitLab ウェブインタフェースに表示されるプロジェクトの説明。 |
CI_PROJECT_URL | 8.10 | 0.5 | プロジェクトの HTTP(S) アドレス。 |
CI_PROJECT_VISIBILITY | 10.3 | すべて | プロジェクトの可視性。internal ,private , またはpublic のいずれかです。 |
CI_PROJECT_CLASSIFICATION_LABEL | 14.2 | すべて | プロジェクト外部承認分類ラベル。 |
CI_REGISTRY_IMAGE | 8.10 | 0.5 | プロジェクトのコンテナレジストリのアドレス。コンテナレジストリがプロジェクトで有効になっている場合にのみ利用できます。 |
CI_REGISTRY_PASSWORD | 9.0 | すべて | プロジェクトのGitLabコンテナレジストリにコンテナをプッシュするためのパスワード。プロジェクトでコンテナレジストリが有効になっている場合のみ使用できます。このパスワード値はCI_JOB_TOKEN と同じで、ジョブが実行されている間だけ有効です。レジストリへの長期アクセスにはCI_DEPLOY_PASSWORD を使用します。 |
CI_REGISTRY_USER | 9.0 | すべて | プロジェクトの GitLab コンテナレジストリにコンテナをプッシュするユーザー名。プロジェクトでコンテナレジストリが有効になっている場合にのみ使用できます。 |
CI_REGISTRY | 8.10 | 0.5 | GitLab コンテナレジストリのアドレス。プロジェクトでコンテナレジストリが有効になっている場合にのみ使用できます。この変数には、レジストリ設定で:port が指定されている場合はその値を含みます。 |
CI_REPOSITORY_URL | 9.0 | すべて | Git clone のフルパス(HTTP) CI/CD ジョブトークンを持つリポジトリhttps://gitlab-ci-token:$CI_JOB_TOKEN@gitlab.example.com/my-group/my-project.git . |
CI_RUNNER_DESCRIPTION | 8.10 | 0.5 | ランナーの説明。 |
CI_RUNNER_EXECUTABLE_ARCH | すべて | 10.6 | GitLab Runner実行ファイルのOS/アーキテクチャ。Executor の環境と同じとは限りません。 |
CI_RUNNER_ID | 8.10 | 0.5 | 使用するRunnerのユニークID。 |
CI_RUNNER_REVISION | すべて | 10.6 | ジョブを実行するRunnerのリビジョン。 |
CI_RUNNER_SHORT_TOKEN | すべて | 12.3 | 新しいジョブリクエストを認証するために使用されるランナー固有のID。GitLab 14.9以降では、トークンはプレフィックスを含み、最初の17文字が使われます。14.9以前では、最初の8文字が使われます。 |
CI_RUNNER_TAGS | 8.10 | 0.5 | Runnerタグのカンマ区切りリスト。 |
CI_RUNNER_VERSION | すべて | 10.6 | ジョブを実行する GitLab Runner のバージョン。 |
CI_SERVER_HOST | 12.1 | すべて | GitLab インスタンス URL のホスト。プロトコルやポートは指定しません。例えばgitlab.example.com . |
CI_SERVER_NAME | すべて | すべて | ジョブを調整するCI/CDサーバーの名前。 |
CI_SERVER_PORT | 12.8 | すべて | GitLabインスタンスURLのポート。ホストやプロトコルは指定しません。例えば8080 . |
CI_SERVER_PROTOCOL | 12.8 | すべて | GitLabインスタンスURLのプロトコルで、ホストやポートは含みません。例えばhttps 。 |
CI_SERVER_SHELL_SSH_HOST | 15.11 | すべて | GitLabインスタンスのSSHホスト。SSH経由でGitリポジトリにアクセスする際に使用します。例えばgitlab.com . |
CI_SERVER_SHELL_SSH_PORT | 15.11 | すべて | GitLabインスタンスのSSHポート。SSH経由でGitリポジトリにアクセスする際に使用します。例えば22 。 |
CI_SERVER_REVISION | すべて | すべて | ジョブをスケジュールするGitLabリビジョン。 |
CI_SERVER_TLS_CA_FILE | すべて | すべて |
Runner設定でtls-ca-file 、GitLabサーバーを検証するためのTLS CA証明書を含むファイル。 |
CI_SERVER_TLS_CERT_FILE | すべて | すべて |
Runner設定でtls-cert-file 、GitLabサーバーを検証するためのTLS証明書を含むファイル。 |
CI_SERVER_TLS_KEY_FILE | すべて | すべて |
Runner設定でtls-key-file 、GitLabサーバーを検証するためのTLSキーを含むファイル。 |
CI_SERVER_URL | 12.7 | すべて | プロトコルとポートを含む、GitLabインスタンスのベースURL。例えばhttps://gitlab.example.com:8080 . |
CI_SERVER_VERSION_MAJOR | 11.4 | すべて | GitLabインスタンスのメジャーバージョン。例えば、GitLab のバージョンが13.6.1 の場合、CI_SERVER_VERSION_MAJOR は13 です。 |
CI_SERVER_VERSION_MINOR | 11.4 | すべて | GitLabインスタンスのマイナーバージョン。例えば、GitLab のバージョンが13.6.1 の場合、CI_SERVER_VERSION_MINOR は6 です。 |
CI_SERVER_VERSION_PATCH | 11.4 | すべて | GitLabインスタンスのパッチバージョン。例えば、GitLab のバージョンが13.6.1 の場合、CI_SERVER_VERSION_PATCH は1 です。 |
CI_SERVER_VERSION | すべて | すべて | GitLab インスタンスのフルバージョン。 |
CI_SERVER | すべて | すべて | CI/CD で実行されるすべてのジョブで利用可能です。yes 利用可能な場合。 |
CI_SHARED_ENVIRONMENT | すべて | 10.1 | ジョブが共有環境(shell やssh Executor のように CI/CD の実行にまたがって永続化されるもの)で実行される場合のみ利用可能です。true 利用可能な場合。 |
CI_TEMPLATE_REGISTRY_HOST | 15.3 | すべて | CI/CDテンプレートが使用するレジストリのホスト。デフォルトはregistry.gitlab.com です。 |
GITLAB_CI | すべて | すべて | CI/CD で実行されるすべてのジョブで利用可能です。true 利用可能な場合。 |
GITLAB_FEATURES | 10.6 | すべて | GitLabインスタンスとライセンスで利用可能なライセンス機能のカンマ区切りリスト。 |
GITLAB_USER_EMAIL | 8.12 | すべて | ジョブが手動ジョブでない限り、パイプラインを開始したユーザーのEメール。手動ジョブの場合、値はジョブを開始したユーザーのEメールです。 |
GITLAB_USER_ID | 8.12 | すべて | ジョブが手動ジョブでない限り、パイプラインを開始したユーザーのID。手動ジョブの場合、値はジョブを開始したユーザーのIDです。 |
GITLAB_USER_LOGIN | 10.0 | すべて | ジョブが手動ジョブでない限り、パイプラインを開始したユーザーのユーザー名。手動ジョブの場合、値はジョブを開始したユーザーのユーザー名です。 |
GITLAB_USER_NAME | 10.0 | すべて | ジョブが手動ジョブでない限り、パイプラインを開始したユーザーの名前。手動ジョブの場合、値はジョブを開始したユーザー名です。 |
KUBECONFIG | 14.2 | すべて | すべての共有エージェント接続のコンテキストを含むkubeconfig ファイルへのパス。GitLabエージェントがプロジェクトにアクセスする権限がある場合にのみ利用可能。 |
TRIGGER_PAYLOAD | 13.9 | すべて | Webhook ペイロード。パイプラインがWebhook でトリガーされた場合にのみ利用可能です。 |
マージリクエストパイプラインの定義済み変数
これらの変数は、以下の場合に使用できます:
- パイプラインがマージリクエストパイプラインである場合。
- マージリクエストはオープンです。
変数 | GitLab | Runner | 説明 |
---|---|---|---|
CI_MERGE_REQUEST_APPROVED | 14.1 | すべて | マージ リクエストの承認ステータス。true マージ リクエストの承認者が利用可能で、マージ リクエストが承認された場合。 |
CI_MERGE_REQUEST_ASSIGNEES | 11.9 | すべて | マージリクエストの担当者のユーザー名のカンマ区切りリスト。 |
CI_MERGE_REQUEST_ID | 11.6 | すべて | マージリクエストのインスタンスレベルのID。GitLab 上のすべてのプロジェクトで一意な ID です。 |
CI_MERGE_REQUEST_IID | 11.6 | すべて | マージリクエストのプロジェクトレベルの IID (内部 ID)。この ID は現在のプロジェクトで一意です。 |
CI_MERGE_REQUEST_LABELS | 11.9 | すべて | マージリクエストのカンマ区切りのラベル名。 |
CI_MERGE_REQUEST_MILESTONE | 11.9 | すべて | マージリクエストのマイルストーンのタイトル。 |
CI_MERGE_REQUEST_PROJECT_ID | 11.6 | すべて | マージリクエストのプロジェクトのID。 |
CI_MERGE_REQUEST_PROJECT_PATH | 11.6 | すべて | マージリクエストのプロジェクトのパス。たとえばnamespace/awesome-project 。 |
CI_MERGE_REQUEST_PROJECT_URL | 11.6 | すべて | マージリクエストのプロジェクトの URL。たとえば、http://192.168.10.15:3000/namespace/awesome-project . |
CI_MERGE_REQUEST_REF_PATH | 11.6 | すべて | マージリクエストの参照パス。たとえば、refs/merge-requests/1/head . |
CI_MERGE_REQUEST_SQUASH_ON_MERGE | 16.4 | すべて |
true マージ時につぶすオプションが設定されている場合。 |
CI_MERGE_REQUEST_SOURCE_BRANCH_NAME | 11.6 | すべて | マージリクエストのソースブランチ名。 |
CI_MERGE_REQUEST_SOURCE_BRANCH_PROTECTED | 16.4 | すべて |
true マージリクエストのソースブランチが保護されている場合。 |
CI_MERGE_REQUEST_SOURCE_BRANCH_SHA | 11.9 | すべて | マージリクエストのソースブランチの HEAD SHA。この変数はマージリクエストパイプラインでは空です。SHA はマージ結果パイプラインにのみ存在します。 |
CI_MERGE_REQUEST_SOURCE_PROJECT_ID | 11.6 | すべて | マージリクエストのソースプロジェクトの ID。 |
CI_MERGE_REQUEST_SOURCE_PROJECT_PATH | 11.6 | すべて | マージリクエストのソースプロジェクトのパス。 |
CI_MERGE_REQUEST_SOURCE_PROJECT_URL | 11.6 | すべて | マージリクエストのソースプロジェクトの URL。 |
CI_MERGE_REQUEST_TARGET_BRANCH_NAME | 11.6 | すべて | マージリクエストの対象ブランチ名。 |
CI_MERGE_REQUEST_TARGET_BRANCH_PROTECTED | 15.2 | すべて |
true マージリクエストのターゲットブランチが保護されている場合。 |
CI_MERGE_REQUEST_TARGET_BRANCH_SHA | 11.9 | すべて | マージリクエストの対象ブランチの HEAD SHA。この変数はマージリクエストパイプラインでは空です。SHA はマージ結果パイプラインにのみ存在します。 |
CI_MERGE_REQUEST_TITLE | 11.9 | すべて | マージリクエストのタイトル。 |
CI_MERGE_REQUEST_EVENT_TYPE | 12.3 | すべて | マージリクエストのイベントタイプ。detached ,merged_result またはmerge_train のいずれかです。 |
CI_MERGE_REQUEST_DIFF_ID | 13.7 | すべて | マージリクエストの差分のバージョン。 |
CI_MERGE_REQUEST_DIFF_BASE_SHA | 13.7 | すべて | マージリクエストの差分のベース SHA。 |
外部プルリクエストパイプライン用の定義済み変数
これらの変数は、以下の場合にのみ使用できます:
- パイプラインが外部プルリクエストパイプラインの場合
- プルリクエストはオープンです。
変数 | GitLab | Runner | 説明 |
---|---|---|---|
CI_EXTERNAL_PULL_REQUEST_IID | 12.3 | すべて | GitHubからのプルリクエストID。 |
CI_EXTERNAL_PULL_REQUEST_SOURCE_REPOSITORY | 13.3 | すべて | プルリクエストのソースリポジトリ名。 |
CI_EXTERNAL_PULL_REQUEST_TARGET_REPOSITORY | 13.3 | すべて | プルリクエストの対象リポジトリ名。 |
CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_NAME | 12.3 | すべて | プルリクエストのソースブランチ名。 |
CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_SHA | 12.3 | すべて | プルリクエストのソースブランチの HEAD SHA。 |
CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_NAME | 12.3 | すべて | プルリクエストの対象ブランチ名。 |
CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_SHA | 12.3 | すべて | プルリクエストの対象ブランチの HEAD SHA。 |
デプロイ変数
デプロイ設定を担当するインテグレーションは、ビルド環境に設定される独自の定義済み変数を定義できます。これらの変数はデプロイジョブに対してのみ定義されます。
たとえば、Kubernetesインテグレーションでは、インテグレーションで使用できるデプロイ変数を定義しています。
各インテグレーションのドキュメントでは、インテグレーションに利用可能なデプロイ変数があるかどうかを説明しています。