GitLab-CI

The gitlab_ci sensor integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] integrates results reported by CI/CD Pipeline Jobs in GitLab.

Setup

You will need a GitLab repository ID. On the Details page for your GitLab repository, just below the project name is Project ID:.

Alternatively, you can use GitLab_Username/GitLab_RepositoryName, e.g., MyCoolUsername/MyCoolRepository.

A GitLab token with at least the API permission scope is needed, which can be created on the GitLab Personal Access Tokens page of your GitLab User Settings.

Configuration

To enable this integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more], please add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# Example configuration.yaml entry
sensor:
  - platform: gitlab_ci
    gitlab_id: YOUR_GITLAB_ID
    token: YOUR_GITLAB_TOKEN

Configuration Variables

gitlab_id string Required

The GitLab repository identifier.

token string Required

The GitLab API token.

name string (Optional, default: GitLab CI Status)

Sensor name as it appears in Home Assistant.

url string (Optional)

The GitLab repository URL. Used for self-hosted repositories.