GitHub

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/core'

Configuration Variables

access_token

(string)(Required)

Your GitHub Access Token

url

(string)(Optional)

If you are using a GitHub Enterprise server, add it’s URL here. For example, https://mygithubserver.com

repositories

(list)(Required)

A list of repository paths and optionally a name

path

(string)(Required)

Path to the repository. For Home Assistant this will be home-assistant/core

name

(string)(Optional)

Name of the sensor. Gives the sensor a custom name in Home Assistant. Defaults to the repository name from GitHub if not specified.