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
1.5 KiB
title, description, logo, ha_category, ha_release, ha_iot_class, redirect_from
| title | description | logo | ha_category | ha_release | ha_iot_class | redirect_from | ||
|---|---|---|---|---|---|---|---|---|
| GitHub Sensor | How to integrate the GitHub sensor into Home Assistant. | github.png |
|
0.88 | Cloud Polling |
|
The GitHub sensor integrates data from GitHub to monitor your favorite repositories.
Setup
To set up this sensor you will need a personal access token. 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:
# 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 %}