VSD Scheduled Reports - adding Reports Generation utility
Problem to solve
GitLab Analytics provide high value to executive, however, these reports are spread across multiple pages in GitLab. The Executives' time is very valuable, and they might not know how to use GitLab UI to get insights that they need.
Proposal
- Add a utility script that collects the data from the GraphQL API and stores it in as markdown.( csv could also be nice, etc.).
- This script should generate a GraphQL query or build it from GitLab repository VSD .graphql files to fetch data
- This utility will be configured via VSD config YAML file.
- The report periods for this MVC is 3 months same as the VSD comparison panel.
- The output of this utility need to generate markdown table with:
- Most recent VSD metrics results.
- Support the VSD config YAML file customization (filters and labels).
- Negative trend will be in red - -85.7% , positive trend will be in green - 7.1% .
- The report title should be with link to VSD.
- Example:
Markdown table proposal:
Metrics comparison for the GitLab.org group ~bug customer | Month to date May 1 - May 4 | April Apr 1 - Apr 30 | March Mar 1 - Mar 31 |
---|---|---|---|
New issues | 585 -85.7% | 4101 +2.2% | 4192 +7.1% |
Edited by Felipe Artur