Mozaïk github widgets
Demo
You can see a live demo of the widgets here
Github Client Configuration
In order to use the Mozaïk github widgets, you should configure its client. It's not required that you provide a token for authentication, but then you'll only be able to see public repos and the rate limit will apply.
parameters
key | env key | required | default | description |
---|---|---|---|---|
token |
GITHUB_API_TOKEN | no | '' | github authentication token |
baseUrl |
GITHUB_BASE_URL | no | https://api.github.com | github api url (useful for enterprise) |
usage
//… api: github: baseUrl: '' token: 'MY_GITHUB_TOKEN'
Widgets
Github User badge
Show github user badge.
parameters
key | required | description |
---|---|---|
user |
yes | github user identifier |
usage
type: 'github.user_badge' user: 'plouc' columns: 1 rows: 1 x: 0 y: 0
Github Repository Top committer
Show most active committer during current week|day
parameters
key | required | default | description |
---|---|---|---|
repository |
yes | — | github repository |
frequency |
no | daily | search top committer for current day or week, possible values are: 'daily', 'weekly' |
usage
type: 'github.top_committer' repository: 'plouc/mozaik' frequency: 'daily' columns: 1 rows: 1 x: 0 y: 0
Github Repository Contributors Stats
Show github contributors stats.
parameters
key | required | description |
---|---|---|
repository |
yes | github repository |
usage
type: 'github.repository_contributors_stats' repository: 'plouc/mozaik' columns: 1 rows: 1 x: 0 y: 0
Github Repository Branches
Show github branches with authors.
parameters
key | required | description |
---|---|---|
repository |
yes | github repository |
title |
no | overrides default title if provided |
usage
type: 'github.branches' repository: 'plouc/mozaik' columns: 1 rows: 1 x: 0 y: 0
Github issue labels donut
Show a donut chart with issue labels distribution
parameters
key | required | description |
---|---|---|
repository |
yes | github repository |
usage
type: 'github.issue_labels_donut' repository: 'plouc/mozaik' columns: 1 rows: 1 x: 0 y: 0
Github issue types treemap
Show a treemap of issue types.
parameters
key | required | description |
---|---|---|
repository |
yes | github repository |
labels |
yes | a list of labels with an associated color |
usage
type: 'github.issue_labels_treemap' repository: 'plouc/mozaik' labels: color: '#6bc2c8' count: 13 name: 'blocker' color: '#5f8cc0' count: 3 name: 'enhancement' color: '#525487' count: 7 name: 'bug' color: '#383b72' count: 16 name: 'help-wanted' columns: 1 rows: 1 x: 0 y: 0
Github status
Shows the latest Github system status information from https://status.github.com/
usage
type: 'github.status' columns: 1 rows: 1 x: 0 y: 0
Github Organization badge
Show github organization badge.
parameters
key | required | description |
---|---|---|
org |
yes | github organization identifier |
usage
type: 'github.organization_badge' organization: 'github' columns: 1 rows: 1 x: 0 y: 0