438741f073
* Added GitLab_CI sensor.
* Fixed indentation issue in example config section.
* Fixes to remove unnecessary return in example config section.
* Fixed missing "
* Updates to sensor.gitlab_ci.markdown
Added optional url, updates to include alternate gitlab_id options.
* Updated to next build, added optional name config to match base module.
* Removed blank lines, wording changes, removed scan_interval.
* ⬆️ ha_release
1.6 KiB
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release | ha_iot_class |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | GitLab-CI Sensor | How to integrate GitLab-CI Job status within Home Assistant. | 2018-09-10 19:00 | true | false | true | true | gitlab.png | Sensor | 0.80 | Cloud Polling |
The GitLab_CI sensor integrates results reported by CI/CD Pipeline Jobs in GitLab.
{% linkable_title 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}", ex: "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.
{% linkable_title Configuration %}
To enable this platform, please add the following to your configuration.yaml file:
# Example configuration.yaml entry
sensor:
- platform: gitlab_ci
gitlab_id: '1234567'
token: 'aaaaaaaaaaAAAAAAAAAA'
{% configuration %} gitlab_id: description: GitLab repository ID or "username/repository" required: true type: string token: description: GitLab API Token required: true type: string name: description: Sensor name as it appears in Home Assistant. Defaults to 'GitLab CI Status'. required: false type: string url: description: GitLab repository URL. Defaults to 'https://gitlab.com'. Used for self-hosted repositories. required: false type: string {% endconfiguration %}