1.7 KiB
| title | description | ha_category | ha_release | ha_iot_class | ha_domain | ha_platforms | ha_integration_type | related | ha_quality_scale | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GitLab-CI | How to integrate GitLab-CI Job status within Home Assistant. |
|
0.8 | Cloud Polling | gitlab_ci |
|
integration |
|
legacy |
The gitlab_ci sensor {% term integration %} 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 {% term integration %}, please add the following to your {% term "configuration.yaml" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
# Example configuration.yaml entry
sensor:
- platform: gitlab_ci
gitlab_id: YOUR_GITLAB_ID
token: YOUR_GITLAB_TOKEN
{% configuration %} gitlab_id: description: The GitLab repository identifier. required: true type: string token: description: The GitLab API token. required: true type: string name: description: Sensor name as it appears in Home Assistant. required: false type: string default: GitLab CI Status url: description: The GitLab repository URL. Used for self-hosted repositories. required: false type: string default: https://gitlab.com {% endconfiguration %}