mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-21 09:36:48 +00:00
ebca3218c7
* Automatically create linkable headers
* Visually improve position of linkable header chain icon
* Do not auto link headers on homepage
* Remove linkable_title everywhere
* 🚑 Re-instante linkable_title plugin as NOOP
61 lines
1.6 KiB
Markdown
61 lines
1.6 KiB
Markdown
---
|
|
layout: page
|
|
title: "GitHub Sensor"
|
|
description: "How to integrate the GitHub sensor into Home Assistant."
|
|
date: 2018-12-24 18:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: github.png
|
|
ha_category:
|
|
- Sensor
|
|
ha_release: 0.88
|
|
ha_iot_class: Cloud Polling
|
|
redirect_from:
|
|
- /components/sensor.github/
|
|
---
|
|
|
|
The GitHub sensor integrates data from [GitHub](https://github.com/) to monitor your favorite repositories.
|
|
|
|
## Setup
|
|
|
|
To set up this sensor you will need a [personal access token](https://github.com/settings/tokens). You will need to check the `repo` scope for the sensor to function.
|
|
|
|
## Configuration
|
|
|
|
To enable this platform, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sensor:
|
|
- platform: github
|
|
access_token: !secret github_access_token
|
|
repositories:
|
|
- path: 'home-assistant/home-assistant'
|
|
```
|
|
|
|
{% configuration %}
|
|
access_token:
|
|
description: Your GitHub Access Token
|
|
required: true
|
|
type: string
|
|
url:
|
|
description: If you are using a GitHub Enterprise server, add it's URL here. For example, `https://mygithubserver.com`
|
|
required: false
|
|
type: string
|
|
repositories:
|
|
description: A list of repository paths and optionally a name
|
|
required: true
|
|
type: list
|
|
keys:
|
|
path:
|
|
description: Path to the repository. For Home Assistant this will be `home-assistant/home-assistant`
|
|
required: true
|
|
type: string
|
|
name:
|
|
description: Name of the sensor. Gives the sensor a custom name in Home Assistant. Defaults to the repository name from GitHub if not specified.
|
|
required: false
|
|
type: string
|
|
{% endconfiguration %}
|