{"id":13688356,"url":"https://github.com/chaoss/grimoirelab","last_synced_at":"2026-01-21T12:01:12.969Z","repository":{"id":38361527,"uuid":"104205088","full_name":"chaoss/grimoirelab","owner":"chaoss","description":"GrimoireLab: platform for software development analytics and insights","archived":false,"fork":false,"pushed_at":"2026-01-08T06:42:25.000Z","size":276920,"stargazers_count":576,"open_issues_count":79,"forks_count":218,"subscribers_count":21,"default_branch":"main","last_synced_at":"2026-01-11T08:34:32.160Z","etag":null,"topics":["chaoss","data-mining","data-visualization","grimoirelab","insights","metrics","software-analytics"],"latest_commit_sha":null,"homepage":"https://chaoss.github.io/grimoirelab/","language":"Roff","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chaoss.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":"GOVERNANCE.md","roadmap":"ROADMAP.md","authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":"MAINTAINERS.md","copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-09-20T11:09:15.000Z","updated_at":"2026-01-10T14:01:28.000Z","dependencies_parsed_at":"2023-02-18T06:00:52.713Z","dependency_job_id":"c472eadf-e221-44fc-9513-5d3bee6978c2","html_url":"https://github.com/chaoss/grimoirelab","commit_stats":{"total_commits":671,"total_committers":48,"mean_commits":"13.979166666666666","dds":0.7719821162444114,"last_synced_commit":"84815ecdcc9d3c0cbcdd340aa5e745698c276138"},"previous_names":[],"tags_count":195,"template":false,"template_full_name":null,"purl":"pkg:github/chaoss/grimoirelab","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chaoss%2Fgrimoirelab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chaoss%2Fgrimoirelab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chaoss%2Fgrimoirelab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chaoss%2Fgrimoirelab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chaoss","download_url":"https://codeload.github.com/chaoss/grimoirelab/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chaoss%2Fgrimoirelab/sbom","scorecard":{"id":273940,"data":{"date":"2025-08-11","repo":{"name":"github.com/chaoss/grimoirelab","commit":"a2e35b4ddf4aceb5bf8f8887d18b986324c43202"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.6,"checks":[{"name":"Code-Review","score":3,"reason":"Found 7/22 approved changesets -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"16 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/docker-image.yml:1","Warn: no topLevel permission defined: .github/workflows/grimoirelab-release.yml:1","Warn: no topLevel permission defined: .github/workflows/release-grimoirelab-component.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/docker-image.yml:55"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":3,"reason":"dependency not pinned by hash detected -- score normalized to 3","details":["Info: Possibly incomplete results: error parsing shell code: expansions not allowed in heredoc words: .github/workflows/grimoirelab-release.yml:561","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/chaoss/grimoirelab/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/chaoss/grimoirelab/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/chaoss/grimoirelab/release.yml/main?enable=pin","Warn: containerImage not pinned by hash: docker/Dockerfile:4: pin your Docker image by updating python:3.12-slim-bookworm to python:3.12-slim-bookworm@sha256:9de390dee60183290a1028e5c193da5a6f905b9bc7307d8299c96a41f480919f","Warn: containerImage not pinned by hash: third-party/Dockerfile-grimoirelab-3p:7: pin your Docker image by updating grimoirelab/full to grimoirelab/full@sha256:05b3abea2f7e44149676e37251dc6b17ff082eed66c1e4e0f6e20f432d4c45c2","Warn: pipCommand not pinned by hash: docker/Dockerfile:69","Warn: pipCommand not pinned by hash: .github/workflows/docker-image.yml:38","Warn: downloadThenRun not pinned by hash: .github/workflows/grimoirelab-release.yml:358","Warn: pipCommand not pinned by hash: .github/workflows/grimoirelab-release.yml:365","Warn: downloadThenRun not pinned by hash: .github/workflows/release-grimoirelab-component.yml:88","Warn: pipCommand not pinned by hash: .github/workflows/release-grimoirelab-component.yml:95","Warn: pipCommand not pinned by hash: .github/workflows/release-grimoirelab-component.yml:298","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:46","Info:   7 out of   7 GitHub-owned GitHubAction dependencies pinned","Info:   6 out of   9 third-party GitHubAction dependencies pinned","Info:   0 out of   2 containerImage dependencies pinned","Info:   0 out of   6 pipCommand dependencies pinned","Info:   0 out of   2 downloadThenRun dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 15 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-79v4-65xg-pq4g"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T14:00:07.494Z","repository_id":38361527,"created_at":"2025-08-17T14:00:07.494Z","updated_at":"2025-08-17T14:00:07.494Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28632781,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T04:47:28.174Z","status":"ssl_error","status_checked_at":"2026-01-21T04:47:22.943Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["chaoss","data-mining","data-visualization","grimoirelab","insights","metrics","software-analytics"],"created_at":"2024-08-02T15:01:12.041Z","updated_at":"2026-01-21T12:01:12.946Z","avatar_url":"https://github.com/chaoss.png","language":"Roff","readme":"# GrimoireLab\n\n[![grimoirelab-showcase](https://user-images.githubusercontent.com/25265451/84442403-30dcce80-ac5b-11ea-9f5b-60266d875ebd.png \"GrimoireLab | CHAOSS Bitergia Analytics\")](https://chaoss.biterg.io/app/kibana#/dashboard/Overview)\n\nGrimoireLab is a [CHAOSS](https://chaoss.community) toolset for software development analytics. It includes a coordinated set of tools\nto retrieve data from systems used to support software development (repositories), store it in databases,\nenrich it by computing relevant metrics, and make it easy to run analytics and visualizations on it.\n\nYou can learn more about GrimoireLab in the [GrimoireLab tutorial](https://chaoss.github.io/grimoirelab-tutorial/),\nor visit the [GrimoireLab website](https://chaoss.github.io/grimoirelab).\n\nMetrics available in GrimoireLab are, in part, developed in the CHAOSS project. For more information regarding CHAOSS metrics, see the latest release at: https://chaoss.community/metrics/\n\n# Getting started\n\nTo ease the newcomer experience we are providing a [default setup](default-grimoirelab-settings)\nto analyze git activity for this repository. For this set up, there are several options to run GrimoireLab:\n\n## Using `docker-compose`\n\nRequirements:\n* **Software**: [git](https://git-scm.com/), [docker client](https://docs.docker.com/get-docker/) and [docker compose](https://docs.docker.com/compose/install/). An example of working configuration:\n```console\nroot@test-68b8628f:~# git --version\ngit version 2.17.1\nroot@test-68b8628f:~# docker --version\nDocker version 19.03.1, build 74b1e89\nroot@test-68b8628f:~# docker-compose --version\ndocker-compose version 1.22.0, build f46880fe\n```\n* **Hardware**: 2 CPU cores, 8GB memory RAM and [enough virtual memory for Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html)\n\nSteps:\n1. Clone this project:\n```console\ngit clone https://github.com/chaoss/grimoirelab\n```\n2. Go to `docker-compose` folder and run the following command:\n```console\ncd grimoirelab/docker-compose\ndocker-compose up -d\n```\n\nYour data will be ready after a while. The waiting time depends on the amount\nof data to fetch from a repo, for small repositories you can expect your data\nto be available after 10-15 minutes.\n\nTo view the data you can access OpenSearch Dashboards at http://localhost:8000\nor use the API directly at http://localhost:9200.\n\nTo manage the identities you can access SortingHat at http://localhost:8000/identities/.\n\nBy default, OpenSearch Dashboards doesn't contain any visualization, but we have\na set of [default dashboards](https://github.com/chaoss/grimoirelab-sigils/tree/main/panels/json/opensearch_dashboards).\nTo import them, open OpenSearch Dashboards, go to `Stack Management` \u003e `Saved Objects`\nand import the files you want.\n\nMore details or troubleshooting in the [docker-compose folder](./docker-compose/README.md).\n\n## Using `docker run`\n\nRequirements:\n* **Software**: [git](https://git-scm.com/) and [docker client](https://docs.docker.com/get-docker/). An example of working configuration:\n```console\nroot@test-68b8628f:~# git --version\ngit version 2.17.1\nroot@test-68b8628f:~# docker --version\nDocker version 19.03.1, build 74b1e89\n```\n* **Hardware**: 2 CPU cores, 8GB memory RAM and set\n* ElasticSearch and Kibana up and running.\n* SortingHat up and running\n\nSteps:\n1. Clone this project:\n```console\ngit clone https://github.com/chaoss/grimoirelab\n```\n2. Go to the project folder and run the following command:\n```console\ncd grimoirelab\ndocker run --net=host \\\n    -v $(pwd)/default-grimoirelab-settings/projects.json:/home/grimoire/conf/projects.json \\\n    -v $(pwd)/default-grimoirelab-settings/setup-docker.cfg:/home/grimoire/conf/setup.cfg \\\n    -t grimoirelab/grimoirelab\n```\n\nYour dashboard will be ready after a while at `http://localhost:8000`. The waiting time depends on the amount of data to fetch from a repo, for small repositories you can expect your data to be visible in the dashboard after 10-15 minutes.\n\nMore details in the [docker folder](./docker/README.md).\n\n## Using on FreeBSD\n\nRecently [FreeBSD](https://www.freebsd.org) has adopted Grimoirelab for their Bugzilla Analysis and have [deployed Grimoirelab](https://grimore.freebsd.org) in their cluster. [FreeBSD Foundation](https://www.freebsdfoundation.org) has been kind enough to share the process of running Grimoire on FreeBSD which is available [here](./FreeBSD.md). This guide will also help who are interested in running Grimoirelab from source instead of deploying them with Docker.\n\n# Breaking changes\n\n## GrimoireLab `1.3.0`. SortingHat permission groups.\n\nStarting from GrimoireLab 1.3.0, creating new users in SortingHat requires\nassigning them to a permission group. By default, they will have read-only\npermissions. Please refer to the following documentation for instructions\non how to update permissions: [assign users to permission groups](https://github.com/chaoss/grimoirelab-sortinghat?tab=readme-ov-file#assign-users-to-permission-groups)\n\n# GrimoireLab components\n\nCurrently, GrimoireLab toolkit is organized in the following repositories:\n\n* Data retrieval related components:\n  * [Perceval](https://github.com/chaoss/grimoirelab-perceval): retrieval of data from data sources\n    * [Perceval (bundle for OPNFV)](https://github.com/chaoss/grimoirelab-perceval-opnfv)\n    * [Perceval (bundle for Mozilla)](https://github.com/chaoss/grimoirelab-perceval-mozilla)\n    * [Perceval (bundle for Puppet)](https://github.com/chaoss/grimoirelab-perceval-puppet)\n    * [Perceval (bundle for Weblate)](https://github.com/chaoss/grimoirelab-perceval-weblate)\n  * [Graal](https://github.com/chaoss/grimoirelab-graal): source data analysis with external tools\n  * [KingArthur](https://github.com/chaoss/grimoirelab-kingarthur): batch processing for massive retrieval\n* Data enrichment related components:\n  * [GrimoireElk](https://github.com/chaoss/grimoirelab-elk): storage and enrichment of data\n  * [Cereslib](https://github.com/chaoss/grimoirelab-cereslib): generic data processor\n  * [SortingHat](https://github.com/chaoss/grimoirelab-sortinghat): identity management\n* Data consumption related components:\n  * [Sigils](https://github.com/chaoss/grimoirelab-sigils): visualizations and dashboards\n  * [Kidash](https://github.com/chaoss/grimoirelab-kidash): visualizations and dashboards manager\n  * [Manuscripts](https://github.com/chaoss/grimoirelab-manuscripts): reporting\n* Platform management, orchestration, and common utils:\n  * [Mordred](https://github.com/chaoss/grimoirelab-mordred): orchestration\n  * [GrimoireLab Toolkit](https://github.com/chaoss/grimoirelab-toolkit): common utilities\n\nThere are also some [components built by the GrimoreLab community](community_components.md),\nwhich can be useful for you. Other related repositories are:\n* [GrimoireLab Tutorial](https://github.com/chaoss/grimoirelab-tutorial)\n* [GrimoireLab as a whole](https://github.com/chaoss/grimoirelab) (this repository)\n\n## Contents of this repository\n\nThis repository is for content relevant to GrimoireLab as a whole. For example:\n\n* Issues for new features or bug reports that affect more than one GrimoireLab module. \nIn this case, let's open an issue here, and when implementing the fix or the feature,\nlet´s comment about the specific tickets in the specific modules that are used.\nFor example, when supporting a new datasource, we will need patches (at least)\nin `Perceval`, `GrimoireELK` and panels. In this case, we would open a feature\nrequest (or the user story) for the whole case, an issue (and later a pull request)\nin `Perceval` for the data retriever, same for `GrimoireELK` for the enriching code,\nand same for `panels`.\n\n* Release notes for most GrimoireLab components (directory [releases](releases)).\n\n* Docker container for showcasing GrimoireLab (directory [docker](docker)).\nIncludes a Dockerfile and configuration files for the GrimoireLab containers\nthat can be used to demo the technology, and can be the basis for real\ndeployments. See more information in the [docker README.md file](docker/README.md).\n\n* If you feel more comfortable with `docker-compose`, the [docker-compose](docker-compose)\nfolder includes instructions and configuration files to deploy GrimoireLab using\n`docker-compose` command.\n\n* Source code of the GrimoireLab components is available in `src`. Each directory is a\nGit submodule, so its contents will not be available after cloning the repository. To\nfetch all the data, and get the latest version, you can run the following command:\n```console\ngit submodule update --init --remote\n```\n\n* How releases of GrimoireLab are built and tested: [Building](BUILDING.md)\n\n## Citation\n\nIf you use GrimoireLab in your research papers, please refer to [GrimoireLab: A toolset for software development analytics](https://doi.org/10.7717/peerj-cs.601):\n\nAPA style:\n\n```\nDueñas S, Cosentino V, Gonzalez-Barahona JM, del Castillo San Felix A, Izquierdo-Cortazar D, Cañas-Díaz L, Pérez García-Plaza A. 2021. GrimoireLab: A toolset for software development analytics. PeerJ Computer Science 7:e601 https://doi.org/10.7717/peerj-cs.601\n```\n\nBibTeX / BibLaTeX:\n\n```\n@Article{duenas2021:grimoirelab,\n  author = \t {Dueñas, Santiago and Cosentino, Valerio and Gonzalez-Barahona, Jesus M. and del Castillo San Felix, Alvaro and Izquierdo-Cortazar,  Daniel and Cañas-Díaz, Luis and Pérez García-Plaza, Alberto},\n  title = \t {GrimoireLab: A toolset for software development analytics},\n  journaltitle = {PeerJ Computer Science},\n  date = \t {2021-07-09},\n  volume = \t 7,\n  number = \t {e601},\n  doi = \t {10.7717/peerj-cs.601},\n  url = \t {https://doi.org/10.7717/peerj-cs.601}}\n```\n\n# Contributing\n\nContributions are welcome, please check the [Contributing Guidelines](CONTRIBUTING.md).\n","funding_links":[],"categories":["data-visualization","Tools","Shell"],"sub_categories":["Others"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchaoss%2Fgrimoirelab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchaoss%2Fgrimoirelab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchaoss%2Fgrimoirelab/lists"}