https://github.com/benct/lovelace-github-entity-row
GitHub repository sensor data on entity rows in Home Assistant's Lovelace UI
https://github.com/benct/lovelace-github-entity-row
card entity entity-rows github hacs home-assistant home-assistant-frontend lovelace lovelace-ui sensor
Last synced: 6 months ago
JSON representation
GitHub repository sensor data on entity rows in Home Assistant's Lovelace UI
- Host: GitHub
- URL: https://github.com/benct/lovelace-github-entity-row
- Owner: benct
- License: mit
- Created: 2019-05-02T22:12:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-18T16:59:23.000Z (almost 2 years ago)
- Last Synced: 2025-05-19T10:17:38.820Z (8 months ago)
- Topics: card, entity, entity-rows, github, hacs, home-assistant, home-assistant-frontend, lovelace, lovelace-ui, sensor
- Language: JavaScript
- Homepage:
- Size: 123 KB
- Stars: 24
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-entity-row
Show GitHub repository sensor data on entity rows in Home Assistant's Lovelace UI
[](https://github.com/benct/lovelace-github-entity-row/releases)
[](https://github.com/benct/lovelace-github-entity-row/releases)
[](https://github.com/benct/lovelace-github-entity-row/commits/master)
[](https://github.com/benct/lovelace-github-entity-row)
[](https://github.com/hacs)
**NOTE:** This is not a standalone lovelace card, but a row element for
the [entities](https://www.home-assistant.io/lovelace/entities/) card.
## Installation
Add [github-entity-row.js](https://raw.githubusercontent.com/benct/lovelace-github-entity-row/master/github-entity-row.js)
to your `/www/` folder and add the following to the `configuration.yaml` file:
```yaml
lovelace:
resources:
- url: /local/github-entity-row.js?v=2.1.0
type: module
```
_OR_ install using [HACS](https://hacs.xyz/) and add this (if in YAML mode):
```yaml
lovelace:
resources:
- url: /hacsfiles/lovelace-github-entity-row/github-entity-row.js
type: module
```
The above configuration can be managed in the Configuration -> Dashboards -> Resources panel when not using YAML mode.
## Configuration
| Name | Type | Default | Description |
|--------|--------|-----------------|-------------------------------------------|
| type | string | **Required** | `custom:github-entity-row` |
| repo | string | **Required** | Your GitHub repository path |
| sensor | string | `_` | Specify a custom sensor entity (optional) |
| name | string | `repo` | Override repository name |
| icon | string | `mdi:github` | Override default entity icon |
The `repo` field needs to exactly match your GitHub user and repository path, i.e. `benct/lovelace-github-entity-row`.
If you rename the sensor entity IDs from the GitHub integration, you can specify the updated sensor ID with the `sensor`
field (without the domain and type suffix). For example, if the integration
exposes `sensor.custom_sensor_id_latest_release`, you should specify `custom_sensor_id`.
## Migrate to version 2
The GitHub [integration](https://www.home-assistant.io/integrations/github/) was changed in HA version `2022.2.0` to
include several sensors for each GitHub repository. If you are using the latest HA installation, you need to upgrade to
version `>2.0.0` of this card. The main change is that the `entity` field has been replaced by ~~user
and~~ `repo` (`user` removed in `2.1.0`). You might also need to manually enable the following sensors from your GitHub
integration; `Stars`, `Issues` and `Pull Requests`.
## Example
```yaml
type: entities
title: GitHub
entities:
- type: custom:github-entity-row
repo: benct/home-assistant-config
name: HA Config
- type: custom:github-entity-row
repo: benct/lovelace-github-entity-row
icon: mdi:github
- type: custom:github-entity-row
repo: benct/lovelace-multiple-entity-row
- type: custom:github-entity-row
repo: benct/lovelace-xiaomi-vacuum-card
```
## My cards
[xiaomi-vacuum-card](https://github.com/benct/lovelace-xiaomi-vacuum-card) |
[multiple-entity-row](https://github.com/benct/lovelace-multiple-entity-row) |
[github-entity-row](https://github.com/benct/lovelace-github-entity-row) |
[battery-entity-row](https://github.com/benct/lovelace-battery-entity-row) |
[~~attribute-entity-row~~](https://github.com/benct/lovelace-attribute-entity-row)
[](https://www.buymeacoff.ee/benct)