mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-03 00:36:50 +00:00
1833c32a2c
* 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
55 lines
1.5 KiB
Markdown
55 lines
1.5 KiB
Markdown
---
|
|
title: "GitLab-CI Sensor"
|
|
description: "How to integrate GitLab-CI Job status within Home Assistant."
|
|
logo: gitlab.png
|
|
ha_category:
|
|
- Sensor
|
|
ha_release: 0.80
|
|
ha_iot_class: Cloud Polling
|
|
redirect_from:
|
|
- /components/sensor.gitlab_ci/
|
|
---
|
|
|
|
The `gitlab_ci` sensor platform integrates results reported by CI/CD Pipeline Jobs in [GitLab](https://gitlab.com/).
|
|
|
|
## 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](https://gitlab.com/profile/personal_access_tokens) page of your GitLab User Settings.
|
|
|
|
## Configuration
|
|
|
|
To enable this platform, please add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# 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 %}
|