This dashboard shows information related to the connection between the issues closed by pull requests. Such connections are derived from the close events returned by the GitHub API. The widgets in the dashboard are described below.
This dashboard is built on top of a search on github_events
index which includes the closing events by pull
requests. The generation of such events is described below.
When a pull request references a keyword (e.g., fixes, closes, resolves) and issue number, GitHub creates an association between the pull request and the issue. When the pull request is merged into the repository’s default branch, the corresponding issue is automatically closed, and the corresponding event is generated.
By default, the closed event includes the author that triggered the action (e.g., the user that merged a pull request).
During the enrichment process, the issue reporter and pull request submitter are also added to the enriched
items (attributes reporter_*
and submitter_*
).
To use this dashboard with your own GrimoireLab deployment you need to:
github_events
index is available on your GrimoireLab instance
(see grimoirelab-sirmordred documentation for details on how to deploy it).Index Pattern | —– | Dashboard |
Once you have the data in place, if you need to manually upload the dashboard execute the following commands:
kidash -e https://user:pass@localhost:443/data --import github_events-index-pattern.json
kidash -e https://user:pass@localhost:443/data --import github_events_closed.json
Edit this doc