@mozaik/ext-gitlab NPM

Mozaïk GitLab widgets

This repository contains some widgets to use with Mozaïk.

Sample gitlab dashboard

You can see a live demo of this extension here

This branch contains code for the version compatible with Mozaïk v2, if you're looking for v1, please use mozaik-1 branch.

client configuration
widgets
- Project
- Project Members
- Project Contributors
- Branches
- Pipelines
  - LatestProjectPipeline
- Jobs
  - Job Histogram
  - Job History
- Labels

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

parameters

key	required	description
`project`	yes	ID or NAMESPACE/PROJECT_NAME of a project

usage

- 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

parameters

key	required	description
`project`	yes	ID or NAMESPACE/PROJECT_NAME of a project

usage

- 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

parameters

key	required	description
`project`	yes	ID or NAMESPACE/PROJECT_NAME of a project

usage

- 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

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

- 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

parameters

key	required	description
`project`	yes	ID or NAMESPACE/PROJECT_NAME of a project

usage

- 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

parameters

key	required	description
`project`	yes	ID or NAMESPACE/PROJECT_NAME of a project

usage

- 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

parameters

key	required	description
`project`	yes	ID or NAMESPACE/PROJECT_NAME of a project

usage

- 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

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

- 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

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

- 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

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

- extension: gitlab
  widget:    LabelsTreemap
  project:   gitlab-org/gitlab-ce
  columns:   1
  rows:      1
  x:         0
  y:         0

gitlab gitlab-ci mozaik widget extension dashboard

chalk convict lodash lodash-es moment prop-types

@everything-registry/sub-chunk-621 @infinitebrahmanuniverse/nolb-_moz

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

8 years ago

8 years ago

8 years ago

8 years ago