The entire process of gathering metrics from GitHub repos consists of these steps:
- Discovering. Get the list of repos from GitHub and then create directories for them.
- Polishing. Delete directories that don't exist in the list of required repositories.
- Unregistering. Clean directories from the CSV register if their clones are absent.
- Cloning. In this step we run
git cloneon found repositories. - JPEEK. Here, we build those gathered repositories and run jpeek on them.
- Filtering. Is where we apply all the filters
in order to get rid of irrelevant classes (such as
*Test,*ITCase, invalid files and so on). Whole filtering process will be printed in the final report, you can check it here. - Measuring. We calculate metrics for each file using these metrics.
- Aggregating. Finally, we aggregate all metrics in summary CSV files.