Github Dwains Dashboard Add-on (more_page)

Github monitoring in Home Assistant Dwains Dashboard. Shows issues, pull requests, and more from your github repositories

Created by Léon van der Linden based on github-flexi-card created by Maxwroc

Prerequisite

---

• Make sure you have installed the lovelace github-flexi-card. This can be done manually or directly via hacs

Make Home Assistant integration

---

• Make the integration with Github in Home Assistant
• Restart Home Assistant

    # Example configuration.yaml entry
    sensor:
      - platform: github
        access_token: !secret github_access_token
        repositories:
          - path: 'LRvdLinden/automations_dd_addon' #path Github URL
            name: Automations Dashboard Dwains Add-on #custom name sensor

• You can use also the example sensoren

Example sensoren

---

## DWAINS DASHBOARD        
     - path: 'dwainscheeren/dwains-lovelace-dashboard'
       name: Dwains Dashboard
     - path: 'dwainscheeren/dwains-dashboard-addons'
       name: Dwains Dashboard addons       
       
## HOME ASSISTANT        
     - path: 'home-assistant/core'
       name: Home Assistant Core
     - path: 'home-assistant/supervisor'
       name: Home Assistant Supervisor 
     - path: 'home-assistant/home-assistant.io'
       name: Home Assistant Website
     - path: 'home-assistant/frontend'
       name: Home Assistant Fronted
     - path: 'home-assistant/operating-system'
       name: Home Assistant OS

Installation Add-on

---

• Copy the github folder in to the dwains-dashboard/addons/more_page directory.
• Open your more_page.yaml file in dwains-dashboard/configs and add the following;

    - name: Github
      main_menu: 'true' #Show this addon in the main navigation bar!
      icon: mdi:github
      path: 'dwains-dashboard/addons/more_page/github/page.yaml'

• Reload the theme configuration via Theme Settings

Replace the following

---

  cards:
    - type: 'custom:github-flexi-card'
      title: Github LRvdLinden
      secondary_info: '{latest_release_tag}'
      url: true
      attribute_urls: true
      attributes:
        - views
        - stargazers
        - open_issues
        - clones
        - forks
        - open_pull_requests
     sort:
       - by: stargazers
       - by: views_unique
         ascending: true
     entities:
       - sensor.automations_dashboard_dwains_add_on
       - sensor.birthday_dwains_add_on
       - sensor.github_dwains_add_on
       - sensor.uptimerobot_dwains_add_on
       - sensor.uptimerobot_lovelace_card

• change title of the card
• add the correct sensor to monitor

Options

---

Entity

Name	Type	Default	Since	Description
entity	string	(required)	v0.1.0	Entity ID e.g. sensor.my_github_project

Entity Properties

Name	Type	Default	Since	Description
name	KString	friendly_name	v0.1.0	Name override
secondary_info	KString		v0.1.0	String to display underneath the entity name
attributes	list(Attribute)		v0.1.0	Attributes to display
url	KString | bool		v0.2.0	Url to open on click/tap. (when true is used the target url becomes repo homepage)
attribute_urls	bool		v0.2.0	When set to true turns on default urls for all the displayed attributes
icon	string	"mdi:github"	v0.2.0	Override for entity icon
compact_view	bool	true	v1.0.0	When set to false big icons (and values) are displayed

Attribute

Name	Type	Default	Since	Description
name	string	(required)	v0.1.0	Name of the attribute
icon	string		v0.1.0	Icon override (there are default icons for most of the available attributes)
url	KString | bool		v0.2.0	Url to open on click/tap. (there are default urls for most of the available attributes, so you can just use true)
label	KString		v0.5.0	Label/text which will be shown instead of the icon

Sort options

Name	Type	Default	Since	Description
by	string	(required)	v1.0.0	Name of the attribute
ascending	bool	false	v1.0.0	Whether to sort ascending or descending

Configuration examples

---

Card

type: 'custom:github-flexi-card'
title: Github projects
entities:
  - entity: sensor.github_dwains_add_on
    secondary_info: 'Released {latest_release_tag}'
    url: "{latest_release_url}" # url taken from attribute
    attributes:
      - name: views
        url: true # default url to graphs/traffic
      - name: stargazers
      - name: open_issues
      - name: clones
        url: "https://my.custom.url/path"
      - name: forks
      - name: open_pull_requests
        url: "{latest_open_pull_request_url}" # url taken from attribute
  - entity: sensor.hideseek_mod
    url: true # default url - repo homepage
    attributes:
      - views
      - stargazers
      - forks
  - entity: sensor.urleditorpro
    name: 'Url Editor Pro (v{latest_release_tag})'
    secondary_info: 'Clones: {clones}'
    attributes:
      - views
      - stargazers
      - open_issues

Entity

Note: different type has to be used custom:github-entity

type: entities
title: Displayed as entity
show_header_toggle: false
entities:
  - sensor.home_assistant_v2_db
  - type: 'custom:github-entity'
    entity: sensor.github_dwains_add_on
    secondary_info: 'Released {latest_release_tag}'
    url: true
    attribute_urls: true
    attributes:
      - views
      - stargazers
      - open_issues
      - clones
      - forks
      - open_pull_requests
  - sensor.hassio_online
  - sensor.last_boot
  - sensor.processor_use

Card-level entity properties

Card-level entity properties are useful when you want to have same settings for all of the entities.

type: 'custom:github-flexi-card'
title: Card-level entity properties
secondary_info: 'Released {latest_release_tag}'
url: true
attribute_urls: true
attributes:
  - views
  - stargazers
  - open_issues
  - clones
  - forks
  - open_pull_requests
entities:
  - sensor.battery_state_card
  - sensor.hideseek_mod
  - sensor.urleditorpro

Labels instead of icons

type: 'custom:github-flexi-card'
title: Labels instead of icons
url: true
attribute_urls: true
attributes:
  - name: views
    label: Views
  - name: stargazers
    label: Stars
  - name: open_issues
    label: Issues
entities:
  - sensor.battery_state_card
  - sensor.hideseek_mod
  - sensor.urleditorpro

Compact view (disabling)

type: 'custom:github-flexi-card'
title: Big icons
url: true
attribute_urls: true
attributes:
  - views
  - stargazers
entities:
  - sensor.battery_state_card
  - entity: sensor.hideseek_mod
    compact_view: false
  - sensor.urleditorpro

Sorting

type: 'custom:github-flexi-card'
title: Sort by starts and views (asc)
secondary_info: '{latest_release_tag}'
url: true
attribute_urls: true
attributes:
  - views_unique
  - stargazers
  - open_issues
  - open_pull_requests
sort:
  - by: stargazers
  - by: views_unique
    ascending: true
entities:
  - sensor.battery_state_card
  - sensor.hideseek_mod
  - sensor.github_flexi_card
  - sensor.urleditorpro
  - entity: sensor.home_assistant_config
    secondary_info: null

Result

---

---

Enjoy my card? Help me out for a couple of 🍻 or a ☕!