mozaik-ext-github
Version:
Mozaik github widgets
242 lines (169 loc) • 6.27 kB
Markdown
# Mozaïk github widgets
[![License][license-image]][license-url]
[![Travis CI][travis-image]][travis-url]
[![NPM version][npm-image]][npm-url]
[![Dependencies][gemnasium-image]][gemnasium-url]
[![Coverage Status][coverage-image]][coverage-url]
![widget count][widget-count-image]
## Demo
You can see a live demo of the widgets [here](http://mozaik-github.herokuapp.com/)
## 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
```javascript
{
//…
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
```javascript
{
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
```javascript
{
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
```javascript
{
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
```javascript
{
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
```javascript
{
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
```javascript
{
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/](https://status.github.com/)
#### usage
```javascript
{
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
```javascript
{
type: 'github.organization_badge',
organization: 'github',
columns: 1, rows: 1, x: 0, y: 0
}
```
[license-image]: https://img.shields.io/github/license/plouc/mozaik-ext-github.svg?style=flat-square
[license-url]: https://github.com/plouc/mozaik-ext-github/blob/master/LICENSE.md
[travis-image]: https://img.shields.io/travis/plouc/mozaik-ext-github.svg?style=flat-square
[travis-url]: https://travis-ci.org/plouc/mozaik-ext-github
[npm-image]: https://img.shields.io/npm/v/mozaik-ext-github.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/mozaik-ext-github
[gemnasium-image]: https://img.shields.io/gemnasium/plouc/mozaik-ext-github.svg?style=flat-square
[gemnasium-url]: https://gemnasium.com/plouc/mozaik-ext-github
[coverage-image]: https://img.shields.io/coveralls/plouc/mozaik-ext-github.svg?style=flat-square
[coverage-url]: https://coveralls.io/github/plouc/mozaik-ext-github
[widget-count-image]: https://img.shields.io/badge/widgets-x10-green.svg?style=flat-square