GitLab Environment Variables

Available Environment Variables

This page lists the environment variables used by idf-ci when integrating with GitLab. You can set them in your shell environment or in .idf_ci.toml where supported by the GitLab settings.

Supported environment variables are read when idf-ci uses them. If a supported value changes between commands in the same process, the next command uses the new value.

pydantic settings idf_ci.envs.GitlabEnvVars

Show JSON schema

{
   "title": "GitlabEnvVars",
   "type": "object",
   "properties": {
      "CI_COMMIT_SHA": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ci Commit Sha"
      },
      "CI_MERGE_REQUEST_IID": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ci Merge Request Iid"
      },
      "CI_MERGE_REQUEST_SOURCE_BRANCH_SHA": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ci Merge Request Source Branch Sha"
      },
      "CI_MERGE_REQUEST_LABELS": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ci Merge Request Labels"
      },
      "CI_MERGE_REQUEST_DESCRIPTION": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ci Merge Request Description"
      },
      "CI_PYTHON_CONSTRAINT_BRANCH": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ci Python Constraint Branch"
      },
      "CHANGED_FILES_SEMICOLON_SEPARATED": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Changed Files Semicolon Separated"
      },
      "PIPELINE_COMMIT_SHA": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Pipeline Commit Sha"
      },
      "IDF_CI_ARTIFACT_NAMESPACE": {
         "anyOf": [
            {
               "pattern": "^[A-Za-z0-9_-]+$",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Idf Ci Artifact Namespace"
      },
      "IDF_TOOLCHAIN": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Idf Toolchain"
      },
      "INCLUDE_NIGHTLY_RUN": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Include Nightly Run"
      },
      "NIGHTLY_RUN": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Nightly Run"
      },
      "GITLAB_HTTPS_SERVER": {
         "default": "https://gitlab.com",
         "title": "Gitlab Https Server",
         "type": "string"
      },
      "GITLAB_ACCESS_TOKEN": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Gitlab Access Token"
      },
      "IDF_S3_SERVER": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Idf S3 Server"
      },
      "IDF_S3_ACCESS_KEY": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Idf S3 Access Key"
      },
      "IDF_S3_SECRET_KEY": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Idf S3 Secret Key"
      },
      "IDF_S3_TIMEOUT_TOTAL": {
         "default": 300.0,
         "title": "Idf S3 Timeout Total",
         "type": "number"
      },
      "IDF_PATH": {
         "default": "",
         "title": "Idf Path",
         "type": "string"
      },
      "EXCLUDE_RUNNER_TAGS": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Exclude Runner Tags"
      },
      "IDF_CI_IS_DEBUG_PIPELINE": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Idf Ci Is Debug Pipeline"
      },
      "IDF_CI_SELECT_BY_FILTER_EXPR": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Idf Ci Select By Filter Expr"
      },
      "IDF_CI_SELECT_ALL_PYTEST_CASES": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Idf Ci Select All Pytest Cases"
      },
      "IDF_CI_SELECT_BY_TARGETS": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Idf Ci Select By Targets"
      },
      "IDF_CI_BUILD_ONLY_TEST_RELATED_APPS": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Idf Ci Build Only Test Related Apps"
      },
      "IDF_CI_BUILD_ONLY_NON_TEST_RELATED_APPS": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Idf Ci Build Only Non Test Related Apps"
      }
   },
   "additionalProperties": false
}

Fields:

• CHANGED_FILES_SEMICOLON_SEPARATED (str | None)

• CI_COMMIT_SHA (str | None)

• CI_MERGE_REQUEST_DESCRIPTION (str | None)

• CI_MERGE_REQUEST_IID (str | None)

• CI_MERGE_REQUEST_LABELS (str | None)

• CI_MERGE_REQUEST_SOURCE_BRANCH_SHA (str | None)

• CI_PYTHON_CONSTRAINT_BRANCH (str | None)

• EXCLUDE_RUNNER_TAGS (str | None)

• GITLAB_ACCESS_TOKEN (str | None)

• GITLAB_HTTPS_SERVER (str)

• IDF_CI_ARTIFACT_NAMESPACE (str | None)

• IDF_CI_BUILD_ONLY_NON_TEST_RELATED_APPS (bool | None)

• IDF_CI_BUILD_ONLY_TEST_RELATED_APPS (bool | None)

• IDF_CI_IS_DEBUG_PIPELINE (bool | None)

• IDF_CI_SELECT_ALL_PYTEST_CASES (bool | None)

• IDF_CI_SELECT_BY_FILTER_EXPR (str | None)

• IDF_CI_SELECT_BY_TARGETS (str | None)

• IDF_PATH (str)

• IDF_S3_ACCESS_KEY (str | None)

• IDF_S3_SECRET_KEY (str | None)

• IDF_S3_SERVER (str | None)

• IDF_S3_TIMEOUT_TOTAL (float)

• IDF_TOOLCHAIN (str | None)

• INCLUDE_NIGHTLY_RUN (str | None)

• NIGHTLY_RUN (str | None)

• PIPELINE_COMMIT_SHA (str | None)

field CHANGED_FILES_SEMICOLON_SEPARATED: str | None = None

Semicolon-separated list of changed files in the pipeline.

field CI_COMMIT_SHA: str | None = None

field CI_MERGE_REQUEST_DESCRIPTION: str | None = None

field CI_MERGE_REQUEST_IID: str | None = None

field CI_MERGE_REQUEST_LABELS: str | None = None

field CI_MERGE_REQUEST_SOURCE_BRANCH_SHA: str | None = None

field CI_PYTHON_CONSTRAINT_BRANCH: str | None = None

field EXCLUDE_RUNNER_TAGS: str | None = None

Semicolon-separated runner-tag exclusions for target tests.

field GITLAB_ACCESS_TOKEN: str | None = None

Access token for GitLab API authentication.

field GITLAB_HTTPS_SERVER: str = 'https://gitlab.com'

GitLab server URL for API calls.

field IDF_CI_ARTIFACT_NAMESPACE: str | None = None

Optional S3 namespace for a build variant of the same commit.

Constraints:

• pattern = ^[A-Za-z0-9_-]+$

field IDF_CI_BUILD_ONLY_NON_TEST_RELATED_APPS: bool | None = None

Flag indicating whether to build only non-test-related apps.

field IDF_CI_BUILD_ONLY_TEST_RELATED_APPS: bool | None = None

Flag indicating whether to build only test-related apps.

field IDF_CI_IS_DEBUG_PIPELINE: bool | None = None

Flag indicating whether this is a debug pipeline.

field IDF_CI_SELECT_ALL_PYTEST_CASES: bool | None = None

Flag indicating whether to select all pytest cases.

field IDF_CI_SELECT_BY_FILTER_EXPR: str | None = None

Filter expression for selecting pytest cases.

field IDF_CI_SELECT_BY_TARGETS: str | None = None

comma-separated list of targets to be built and tested.

field IDF_PATH: str = ''

Path to the ESP-IDF directory.

field IDF_S3_ACCESS_KEY: str | None = None

S3 access key for authentication.

field IDF_S3_SECRET_KEY: str | None = None

S3 secret key for authentication.

field IDF_S3_SERVER: str | None = None

S3 server endpoint URL.

field IDF_S3_TIMEOUT_TOTAL: float = 300.0

S3 total request timeout in seconds.

field IDF_TOOLCHAIN: str | None = None

Toolchain used by build manifests and for selecting collected app lists.

field INCLUDE_NIGHTLY_RUN: str | None = None

Include nightly run jobs and test cases.

field NIGHTLY_RUN: str | None = None

Only run nightly jobs and test cases.

field PIPELINE_COMMIT_SHA: str | None = None

Commit SHA of the source branch rather than the merge result.