{"id":15998149,"url":"https://github.com/plouc/mozaik-ext-gitlab","last_synced_at":"2025-03-17T15:32:34.582Z","repository":{"id":7076617,"uuid":"54683563","full_name":"plouc/mozaik-ext-gitlab","owner":"plouc","description":"Mozaïk GitLab widgets","archived":false,"fork":false,"pushed_at":"2023-01-10T21:59:00.000Z","size":2238,"stargazers_count":19,"open_issues_count":24,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-28T01:18:56.414Z","etag":null,"topics":["dashboard","dataviz","gitlab","gitlab-widget","mozaik"],"latest_commit_sha":null,"homepage":"https://mozaik-gitlab.herokuapp.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/plouc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-25T00:40:52.000Z","updated_at":"2023-06-28T03:09:32.000Z","dependencies_parsed_at":"2023-01-13T15:01:15.146Z","dependency_job_id":null,"html_url":"https://github.com/plouc/mozaik-ext-gitlab","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plouc%2Fmozaik-ext-gitlab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plouc%2Fmozaik-ext-gitlab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plouc%2Fmozaik-ext-gitlab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plouc%2Fmozaik-ext-gitlab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/plouc","download_url":"https://codeload.github.com/plouc/mozaik-ext-gitlab/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243869566,"owners_count":20361037,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dashboard","dataviz","gitlab","gitlab-widget","mozaik"],"created_at":"2024-10-08T08:07:33.962Z","updated_at":"2025-03-17T15:32:34.096Z","avatar_url":"https://github.com/plouc.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mozaïk GitLab widgets\n\n[![License][license-image]][license-url]\n[![Travis CI][travis-image]][travis-url]\n[![NPM version][npm-image]][npm-url]\n[![Coverage Status][coverage-image]][coverage-url]\n![widget count][widget-count-image]\n\nThis repository contains some widgets to use with [Mozaïk](https://github.com/plouc/mozaik).\n\n![Sample gitlab dashboard](preview/sample_dashboard.png)\n\nYou can see a live demo of this extension [here](http://mozaik-gitlab.herokuapp.com/)\n\n[![Deploy][heroku-image]][heroku-url]\n\n\u003e This branch contains code for the version compatible with\n\u003e Mozaïk v2, if you're looking for v1, please use\n\u003e [mozaik-1 branch](https://github.com/plouc/mozaik-ext-gitlab/tree/mozaik-1).\n\n- [client configuration](#client-configuration)\n- widgets\n    - [Project](#project)\n    - [Project Members](#project-members)\n    - [Project Contributors](#gitlab-project-contributors)\n    - [Branches](#gitlab-branches)\n    - Pipelines\n        - [LatestProjectPipeline](#latestprojectpipeline)\n    - Jobs\n        - [Job Histogram](#gitlab-job-histogram)\n        - [Job History](#gitlab-job-history)\n    - Labels\n        - [Labels Bubble chart](#gitlab-labels-bubble-chart)\n        - [Labels Pie](#gitlab-labels-pie)\n        - [Labels Tree map](#gitlab-labels-tree-map)\n\n## Client Configuration\n\nIn order to use the Mozaïk gitlab extension, you must configure its **client**.\nConfiguration is loaded from environment variables.\n\n| env key          | required | default | description\n|------------------|----------|---------|----------------------------\n| GITLAB_BASE_URL  | yes      |         | gitlab API base url, eg. `'https://gitlab.com/api/v4`\n| GITLAB_API_TOKEN | yes      |         | gitlab API token\n\n## Project\n\n\u003e Show GitLab project info.\n\n![Gitlab project](preview/project.png)\n\n### parameters\n\nkey       | required | description\n----------|----------|--------------------------\n`project` | yes      | *ID or NAMESPACE/PROJECT_NAME of a project*\n\n### usage\n\n``` yaml\n- extension: gitlab\n  widget:    Project\n  project:   gitlab-org/gitlab-ce\n  columns:   1\n  rows:      1\n  x:         0\n  y:         0\n```\n\n## Project Members\n\n\u003e Show GitLab project members.\n\n![Gitlab project members](preview/project_members.png)\n\n### parameters\n\nkey       | required | description\n----------|----------|--------------------------\n`project` | yes      | *ID or NAMESPACE/PROJECT_NAME of a project*\n\n### usage\n\n``` yaml\n- extension: gitlab\n  widget:    ProjectMembers\n  project:   gitlab-org/gitlab-ce\n  columns:   1\n  rows:      1\n  x:         0\n  y:         0\n```\n\n## GitLab Branches\n\n\u003e Show GitLab project branches.\n\n![Gitlab project branches](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_branches.png)\n\n### parameters\n\nkey       | required | description\n----------|----------|--------------------------\n`project` | yes      | *ID or NAMESPACE/PROJECT_NAME of a project*\n\n### usage\n\n``` yaml\n- extension: gitlab\n  widget:    Branches\n  project:   gitlab-org/gitlab-ce\n  columns:   1\n  rows:      1\n  x:         0\n  y:         0\n```\n\n## LatestProjectPipeline\n\n\u003e Show details about latest project pipeline.\n\n![LatestProjectPipeline](preview/latest_project_pipeline.png)\n\n### parameters\n\nkey                 | type        | required | default | description\n--------------------|-------------|----------|---------|-------------\n`project`           | `{string}`  | yes      |         | ID or NAMESPACE/PROJECT_NAME of a project\n`gitRef`            | `{string}`  | no       |         | Get latest pipeline for a specific ref (branch, tag…)\n`hideCommitMessage` | `{boolean}` | no       | `false` | Hide pipeline commit info\n\n### usage\n\n``` yaml\n- extension:         gitlab\n  widget:            LatestProjectPipeline\n  project:           gitlab-org/gitlab-runner\n  gitRef:            master\n  hideCommitMessage: false\n  columns:           2\n  rows:              1\n  x:                 0\n  y:                 0\n```\n\n## GitLab Job Histogram\n\n\u003e Show GitLab project job histogram.\n\n![Gitlab project job histogram](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_build_histogram.png)\n\n### parameters\n\nkey       | required | description\n----------|----------|--------------------------\n`project` | yes      | *ID or NAMESPACE/PROJECT_NAME of a project*\n\n### usage\n\n``` yaml\n- extension: gitlab\n  widget:    JobHistogram\n  project:   gitlab-org/gitlab-ce\n  columns:   2\n  rows:      1\n  x:         0\n  y:         0\n```\n\n## GitLab Job History\n\n\u003e Show GitLab project job history.\n\n![Gitlab project job history](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_build_history.png)\n\n### parameters\n\nkey       | required | description\n----------|----------|--------------------------\n`project` | yes      | *ID or NAMESPACE/PROJECT_NAME of a project*\n\n### usage\n\n``` yaml\n- extension: gitlab\n  widget:    JobHistory\n  project:   gitlab-org/gitlab-ce\n  columns:   1\n  rows:      1\n  x:         0\n  y:         0\n```\n\n## GitLab Project Contributors\n\n\u003e Show GitLab project contributors.\n\n![Gitlab project contributors](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_project_contributors.png)\n\n### parameters\n\nkey       | required | description\n----------|----------|--------------------------\n`project` | yes      | *ID or NAMESPACE/PROJECT_NAME of a project*\n\n### usage\n\n``` yaml\n- extension: gitlab\n  widget:    ProjectContributors\n  project:   gitlab-org/gitlab-ce\n  columns:   1\n  rows:      1\n  x:         0\n  y:         0\n```\n\n## GitLab labels bubble chart\n\n\u003e Show GitLab project's labels stats using a bubble chart.\n\n![Gitlab labels bubble chart](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_labels_bubble.png)\n\n### parameters\n\nkey       | required | default               | description\n----------|----------|-----------------------|----------------\n`project` | yes      | *n/a*                 | *ID or NAMESPACE/PROJECT_NAME of a project*\n`countBy` | yes      | `'open_issues_count'` | *Defines which count to use, must be one of: `'open_issues_count'`, `'closed_issues_count'`, `'open_merge_requests_count'`*\n`title`   | no       | *n/a*                 | *Overrides widget title*\n\n### usage\n\n``` yaml\n- extension: gitlab\n  widget:    LabelsBubble\n  project:   gitlab-org/gitlab-ce\n  columns:   1\n  rows:      1\n  x:         0\n  y:         0\n```\n\n## GitLab labels pie\n\n\u003e Show GitLab project's labels stats using a pie chart.\n\n![Gitlab labels pie](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_labels_pie.png)\n\n### parameters\n\nkey       | required | default               | description\n----------|----------|-----------------------|----------------\n`project` | yes      | *n/a*                 | *ID or NAMESPACE/PROJECT_NAME of a project*\n`countBy` | yes      | `'open_issues_count'` | *Defines which count to use, must be one of: `'open_issues_count'`, `'closed_issues_count'`, `'open_merge_requests_count'`*\n`title`   | no       | *n/a*                 | *Overrides widget title*\n\n### usage\n\n``` yaml\n- extension: gitlab\n  widget:    LabelsPie\n  project:   gitlab-org/gitlab-ce\n  columns:   1\n  rows:      1\n  x:         0\n  y:         0\n```\n\n## GitLab labels tree map\n\n\u003e Show GitLab project's labels stats using a tree map chart.\n\n![Gitlab labels tree map](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_labels_treemap.png)\n\n### parameters\n\nkey       | required | default               | description\n----------|----------|-----------------------|----------------\n`project` | yes      | *n/a*                 | *ID or NAMESPACE/PROJECT_NAME of a project*\n`countBy` | yes      | `'open_issues_count'` | *Defines which count to use, must be one of: `'open_issues_count'`, `'closed_issues_count'`, `'open_merge_requests_count'`*\n`title`   | no       | *n/a*                 | *Overrides widget title*\n\n### usage\n\n``` yaml\n- extension: gitlab\n  widget:    LabelsTreemap\n  project:   gitlab-org/gitlab-ce\n  columns:   1\n  rows:      1\n  x:         0\n  y:         0\n```\n\n\n[license-image]: https://img.shields.io/github/license/plouc/mozaik-ext-gitlab.svg?style=flat-square\n[license-url]: https://github.com/plouc/mozaik-ext-gitlab/blob/master/LICENSE.md\n[travis-image]: https://img.shields.io/travis/plouc/mozaik-ext-gitlab.svg?style=flat-square\n[travis-url]: https://travis-ci.org/plouc/mozaik-ext-gitlab\n[npm-image]: https://img.shields.io/npm/v/@mozaik/ext-gitlab.svg?style=flat-square\n[npm-url]: https://www.npmjs.com/package/@mozaik/ext-gitlab\n[coverage-image]: https://img.shields.io/coveralls/plouc/mozaik-ext-gitlab.svg?style=flat-square\n[coverage-url]: https://coveralls.io/github/plouc/mozaik-ext-gitlab\n[widget-count-image]: https://img.shields.io/badge/widgets-x12-green.svg?style=flat-square\n[heroku-image]: https://www.herokucdn.com/deploy/button.svg\n[heroku-url]: https://heroku.com/deploy?template=https://github.com/plouc/mozaik-ext-gitlab/tree/demo\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplouc%2Fmozaik-ext-gitlab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplouc%2Fmozaik-ext-gitlab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplouc%2Fmozaik-ext-gitlab/lists"}