
* Sets front matter defaults * Removes default front matter from section templates/pages * Removes default front matter from addon pages * Removes default front matter from integration pages * Removes default front matter from posts * Removes default front matter from docs pages * Removes default front matter from other pages * Fixes blog category pages
1.5 KiB
title | description | logo | ha_category | ha_release | ha_iot_class | redirect_from | ||
---|---|---|---|---|---|---|---|---|
GitLab-CI Sensor | How to integrate GitLab-CI Job status within Home Assistant. | gitlab.png |
|
0.80 | Cloud Polling |
|
The gitlab_ci
sensor platform 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 repo, 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 platform, please add the following to your configuration.yaml
file:
# 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 %}