Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/plouc/mozaik-ext-gitlab

Mozaïk GitLab widgets
https://github.com/plouc/mozaik-ext-gitlab
dashboard dataviz gitlab gitlab-widget mozaik
Last synced: 3 months ago
JSON representation
Mozaïk GitLab widgets
Host: GitHub
URL: https://github.com/plouc/mozaik-ext-gitlab
Owner: plouc
License: mit
Created: 2016-03-25T00:40:52.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2023-01-10T21:59:00.000Z (almost 2 years ago)
Last Synced: 2024-10-09T08:08:25.791Z (3 months ago)
Topics: dashboard, dataviz, gitlab, gitlab-widget, mozaik
Language: JavaScript
Homepage: https://mozaik-gitlab.herokuapp.com/
Size: 2.13 MB
Stars: 19
Watchers: 3
Forks: 12
Open Issues: 24
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project

README

        # Mozaïk GitLab widgets

[![License][license-image]][license-url]

[![Travis CI][travis-image]][travis-url]

[![NPM version][npm-image]][npm-url]

[![Coverage Status][coverage-image]][coverage-url]

![widget count][widget-count-image]

This repository contains some widgets to use with [Mozaïk](https://github.com/plouc/mozaik).

![Sample gitlab dashboard](preview/sample_dashboard.png)

You can see a live demo of this extension [here](http://mozaik-gitlab.herokuapp.com/)

[![Deploy][heroku-image]][heroku-url]

> This branch contains code for the version compatible with

> Mozaïk v2, if you're looking for v1, please use

> [mozaik-1 branch](https://github.com/plouc/mozaik-ext-gitlab/tree/mozaik-1).

- [client configuration](#client-configuration)

- widgets

    - [Project](#project)

    - [Project Members](#project-members)

    - [Project Contributors](#gitlab-project-contributors)

    - [Branches](#gitlab-branches)

    - Pipelines

        - [LatestProjectPipeline](#latestprojectpipeline)

    - Jobs

        - [Job Histogram](#gitlab-job-histogram)

        - [Job History](#gitlab-job-history)

    - Labels

        - [Labels Bubble chart](#gitlab-labels-bubble-chart)

        - [Labels Pie](#gitlab-labels-pie)

        - [Labels Tree map](#gitlab-labels-tree-map)

## Client Configuration

In order to use the Mozaïk gitlab extension, you must configure its **client**.

Configuration is loaded from environment variables.

| env key          | required | default | description

|------------------|----------|---------|----------------------------

| GITLAB_BASE_URL  | yes      |         | gitlab API base url, eg. `'https://gitlab.com/api/v4`

| GITLAB_API_TOKEN | yes      |         | gitlab API token

## Project

> Show GitLab project info.

![Gitlab project](preview/project.png)

### parameters

key       | required | description

----------|----------|--------------------------

`project` | yes      | *ID or NAMESPACE/PROJECT_NAME of a project*

### usage

``` yaml

- extension: gitlab

  widget:    Project

  project:   gitlab-org/gitlab-ce

  columns:   1

  rows:      1

  x:         0

  y:         0

```

## Project Members

> Show GitLab project members.

![Gitlab project members](preview/project_members.png)

### parameters

key       | required | description

----------|----------|--------------------------

`project` | yes      | *ID or NAMESPACE/PROJECT_NAME of a project*

### usage

``` yaml

- extension: gitlab

  widget:    ProjectMembers

  project:   gitlab-org/gitlab-ce

  columns:   1

  rows:      1

  x:         0

  y:         0

```

## GitLab Branches

> Show GitLab project branches.

![Gitlab project branches](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_branches.png)

### parameters

key       | required | description

----------|----------|--------------------------

`project` | yes      | *ID or NAMESPACE/PROJECT_NAME of a project*

### usage

``` yaml

- extension: gitlab

  widget:    Branches

  project:   gitlab-org/gitlab-ce

  columns:   1

  rows:      1

  x:         0

  y:         0

```

## LatestProjectPipeline

> Show details about latest project pipeline.

![LatestProjectPipeline](preview/latest_project_pipeline.png)

### parameters

key                 | type        | required | default | description

--------------------|-------------|----------|---------|-------------

`project`           | `{string}`  | yes      |         | ID or NAMESPACE/PROJECT_NAME of a project

`gitRef`            | `{string}`  | no       |         | Get latest pipeline for a specific ref (branch, tag…)

`hideCommitMessage` | `{boolean}` | no       | `false` | Hide pipeline commit info

### usage

``` yaml

- extension:         gitlab

  widget:            LatestProjectPipeline

  project:           gitlab-org/gitlab-runner

  gitRef:            master

  hideCommitMessage: false

  columns:           2

  rows:              1

  x:                 0

  y:                 0

```

## GitLab Job Histogram

> Show GitLab project job histogram.

![Gitlab project job histogram](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_build_histogram.png)

### parameters

key       | required | description

----------|----------|--------------------------

`project` | yes      | *ID or NAMESPACE/PROJECT_NAME of a project*

### usage

``` yaml

- extension: gitlab

  widget:    JobHistogram

  project:   gitlab-org/gitlab-ce

  columns:   2

  rows:      1

  x:         0

  y:         0

```

## GitLab Job History

> Show GitLab project job history.

![Gitlab project job history](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_build_history.png)

### parameters

key       | required | description

----------|----------|--------------------------

`project` | yes      | *ID or NAMESPACE/PROJECT_NAME of a project*

### usage

``` yaml

- extension: gitlab

  widget:    JobHistory

  project:   gitlab-org/gitlab-ce

  columns:   1

  rows:      1

  x:         0

  y:         0

```

## GitLab Project Contributors

> Show GitLab project contributors.

![Gitlab project contributors](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_project_contributors.png)

### parameters

key       | required | description

----------|----------|--------------------------

`project` | yes      | *ID or NAMESPACE/PROJECT_NAME of a project*

### usage

``` yaml

- extension: gitlab

  widget:    ProjectContributors

  project:   gitlab-org/gitlab-ce

  columns:   1

  rows:      1

  x:         0

  y:         0

```

## GitLab labels bubble chart

> Show GitLab project's labels stats using a bubble chart.

![Gitlab labels bubble chart](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_labels_bubble.png)

### parameters

key       | required | default               | description

----------|----------|-----------------------|----------------

`project` | yes      | *n/a*                 | *ID or NAMESPACE/PROJECT_NAME of a project*

`countBy` | yes      | `'open_issues_count'` | *Defines which count to use, must be one of: `'open_issues_count'`, `'closed_issues_count'`, `'open_merge_requests_count'`*

`title`   | no       | *n/a*                 | *Overrides widget title*

### usage

``` yaml

- extension: gitlab

  widget:    LabelsBubble

  project:   gitlab-org/gitlab-ce

  columns:   1

  rows:      1

  x:         0

  y:         0

```

## GitLab labels pie

> Show GitLab project's labels stats using a pie chart.

![Gitlab labels pie](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_labels_pie.png)

### parameters

key       | required | default               | description

----------|----------|-----------------------|----------------

`project` | yes      | *n/a*                 | *ID or NAMESPACE/PROJECT_NAME of a project*

`countBy` | yes      | `'open_issues_count'` | *Defines which count to use, must be one of: `'open_issues_count'`, `'closed_issues_count'`, `'open_merge_requests_count'`*

`title`   | no       | *n/a*                 | *Overrides widget title*

### usage

``` yaml

- extension: gitlab

  widget:    LabelsPie

  project:   gitlab-org/gitlab-ce

  columns:   1

  rows:      1

  x:         0

  y:         0

```

## GitLab labels tree map

> Show GitLab project's labels stats using a tree map chart.

![Gitlab labels tree map](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_labels_treemap.png)

### parameters

key       | required | default               | description

----------|----------|-----------------------|----------------

`project` | yes      | *n/a*                 | *ID or NAMESPACE/PROJECT_NAME of a project*

`countBy` | yes      | `'open_issues_count'` | *Defines which count to use, must be one of: `'open_issues_count'`, `'closed_issues_count'`, `'open_merge_requests_count'`*

`title`   | no       | *n/a*                 | *Overrides widget title*

### usage

``` yaml

- extension: gitlab

  widget:    LabelsTreemap

  project:   gitlab-org/gitlab-ce

  columns:   1

  rows:      1

  x:         0

  y:         0

```

[license-image]: https://img.shields.io/github/license/plouc/mozaik-ext-gitlab.svg?style=flat-square

[license-url]: https://github.com/plouc/mozaik-ext-gitlab/blob/master/LICENSE.md

[travis-image]: https://img.shields.io/travis/plouc/mozaik-ext-gitlab.svg?style=flat-square

[travis-url]: https://travis-ci.org/plouc/mozaik-ext-gitlab

[npm-image]: https://img.shields.io/npm/v/@mozaik/ext-gitlab.svg?style=flat-square

[npm-url]: https://www.npmjs.com/package/@mozaik/ext-gitlab

[coverage-image]: https://img.shields.io/coveralls/plouc/mozaik-ext-gitlab.svg?style=flat-square

[coverage-url]: https://coveralls.io/github/plouc/mozaik-ext-gitlab

[widget-count-image]: https://img.shields.io/badge/widgets-x12-green.svg?style=flat-square

[heroku-image]: https://www.herokucdn.com/deploy/button.svg

[heroku-url]: https://heroku.com/deploy?template=https://github.com/plouc/mozaik-ext-gitlab/tree/demo