Alambic

• About
• Plugins
• Setup
• Documentation
• Development

GitLab Project

This plugin retrieves project-related information from a GitLab server and displays a summary of its status.

Check the plugin Perl documentation in the perldoc section.

---

Basic information

• ID: GitLabProject
• Abilities: info, data, metrics, figs, recs, viz
• Description: Retrieves project-related information from a GitLab server, and displays a summary of its status.
• Parameters:
  • gitlab_url The URL of the GitLab instance, e.g. http://mygitlab.mycompany.com.
  • gitlab_id The ID used to identify the project in the GitLab forge. It can be the internal ID (e.g. 22354) or the path of the project (e.g. borisbaldassari/Alambic).
  • gitlab_token The private token used to access the gitlab instance. The private token must be generated by a user who has global rights on all analysed projects. It is generated, downlaoded and reset from the user's account page (/profile/account).

---

Provides

Metrics

• PROJECT_AUTHORS
• PROJECT_AUTHORS_1M
• PROJECT_AUTHORS_1W
• PROJECT_AUTHORS_1Y
• PROJECT_COMMITS
• PROJECT_COMMITS_1M
• PROJECT_COMMITS_1W
• PROJECT_COMMITS_1Y
• PROJECT_COMMITTERS
• PROJECT_COMMITTERS_1M
• PROJECT_COMMITTERS_1W
• PROJECT_COMMITTERS_1Y
• PROJECT_FORKS
• PROJECT_ISSUES_OPEN
• PROJECT_LAST_ACTIVITY_AT
• PROJECT_STARS
• SCM_PRS
• SCM_PRS_CLOSED
• SCM_PRS_MERGED
• SCM_PRS_OPENED
• SCM_PRS_OPENED_1M
• SCM_PRS_OPENED_1W
• SCM_PRS_OPENED_1Y
• SCM_PRS_OPENED_STALED_1M
• SCM_PRS_OPENED_STILL_1M
• SCM_PRS_OPENED_STILL_1W
• SCM_PRS_OPENED_STILL_1Y

Information

• PROJECT_AVATAR e.g. https://assets.gitlab-static.net/uploads/-/system/project/avatar/250833/runner_logo.png
• PROJECT_CI_ENABLED e.g. 1
• PROJECT_CI_URL e.g. https://gitlab.com/gitlab-org/gitlab-runner/pipelines
• PROJECT_COMMITS_URL e.g. https://gitlab.com/gitlab-org/gitlab-runner/commits/master
• PROJECT_CREATED_AT e.g. 2015-04-27T21:10:25.322Z
• PROJECT_ISSUES_ENABLED e.g. 1
• PROJECT_ISSUES_URL e.g. https://gitlab.com/gitlab-org/gitlab-runner/issues
• PROJECT_MRS_ENABLED e.g. 1
• PROJECT_MRS_URL e.g. https://gitlab.com/gitlab-org/gitlab-runner/merge_requests
• PROJECT_NAME_SPACE e.g. GitLab.org / gitlab-runner
• PROJECT_OWNER_ID e.g.905787
• PROJECT_OWNER_NAME e.g. Boris Baldassari
• PROJECT_REPO_HTTP e.g. https://gitlab.com/gitlab-org/gitlab-runner.git
• PROJECT_REPO_SSH e.g. git@gitlab.com:gitlab-org/gitlab-runner.git
• PROJECT_SNIPPETS_ENABLED e.g. 0
• PROJECT_URL e.g. https://gitlab.com/gitlab-org/gitlab-runner
• PROJECT_VISIBILITY e.g. public
• PROJECT_WEB e.g. https://gitlab.com/gitlab-org/gitlab-runner
• PROJECT_WIKI_ENABLED e.g. 0
• PROJECT_WIKI_URL e.g. https://gitlab.com/gitlab-org/gitlab-runner/wikis/home

Downloads

• import_gitlab_project_contributors.json: Original JSON file listing contributors, as retrieved from the GitLab server (JSON).
• import_gitlab_project_events.json: Original JSON file listing events on the project, as retrieved from the GitLab server (JSON).
• import_gitlab_project_branches.json: Original JSON file describing branches, as retrieved from the GitLab server (JSON).
• import_gitlab_project_commits.json: Original build file from GitLab server (JSON).
• import_gitlab_project_merge_requests.json: Original build file from GitLab server (JSON).",
• metrics_gitlab_project.csv: All metrics computed by the GitLab Project plugin (CSV).
• metrics_gitlab_project.json: All metrics computed by the GitLab Project plugin (JSON).
• info_gitlab_project.csv: All information computed by the GitLab Project plugin (CSV).",
• gitlab_project_branches.csv: CSV file describing branches in the repository of the project (CSV).
• gitlab_project_milestones.csv: CSV file describing milestones of the project (CSV).
• gitlab_git_merge_requests.csv: List of merge requests (CSV).
• gitlab_git_merge_requests.json: List of merge requests (JSON).
• gitlab_git_commits.csv: List of commits (CSV).
• gitlab_git_commits.json: List of commits (JSON).
• gitlab_git_commits_hist.csv: Evolution of commits, sorted by date (CSV).

Visualisation

• GitLab Project

---

Screenshot