diff --git a/source/_integrations/github.markdown b/source/_integrations/github.markdown index 18f7ac9a102..e6f9860834f 100644 --- a/source/_integrations/github.markdown +++ b/source/_integrations/github.markdown @@ -1,8 +1,9 @@ --- title: GitHub -description: How to integrate the GitHub sensor into Home Assistant. +description: Instructions on how to integrate the GitHub integration into Home Assistant. ha_category: - Sensor +ha_config_flow: true ha_release: 0.88 ha_iot_class: Cloud Polling ha_domain: github @@ -13,45 +14,26 @@ ha_codeowners: - '@ludeeus' --- -The GitHub sensor allows you to monitor your favorite [GitHub](https://github.com/) repositories. Monitored information includes the amount of stargazers, forks, open issues and pull requests, the latest commit message, and more. +The GitHub integration allows you to monitor your favorite [GitHub][github] repositories. -## Setup +{% include integrations/config_flow.md %} -To set up this sensor you will need a GitHub [personal access token](https://github.com/settings/tokens). You will need to check the `repo` scope for the sensor to function. +When you set up this integration, you will first be guided to allow the integration to use the [GitHub API][github_api] on your behalf. If you do not yet have a [GitHub][github] account you will be prompted to create one during the configuration of the integration. -## Configuration +When you have authorized the integration, you select repositories you want to monitor, the list contains repositories you have [starred][github_starred] on GitHub with your account. -To enable this platform, add the following to your `configuration.yaml` file: +Most of the entities provided by this integration are disabled by default, you can enable these by going to the {% my entities title="entities panel" %}. -```yaml -# Example configuration.yaml entry -sensor: - - platform: github - access_token: !secret github_access_token - repositories: - - path: 'home-assistant/core' -``` +## Remove authorization -{% configuration %} -access_token: - description: Your GitHub Access Token - required: true - type: string -url: - description: If you are using a GitHub Enterprise server, add its 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/core` - 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 %} +After you have removed the integration from {% my integrations title="Configuration -> Devices & Services" %}, you need to manually revoke OAuth app authorization. + +1. Go to your [Authorized OAuth Apps][github_apps] +2. Find the "Home Assistant GitHub Integration" application +3. Click the 3 dots (`...`) to the right of the name +4. Select "Revoke" + +[github]: https://github.com/ +[github_api]: https://docs.github.com/en/rest +[github_starred]: https://github.com/stars +[github_apps]: https://github.com/settings/applications