Project

gitstrider

0.0
No commit activity in last 3 years
No release in over 3 years
GitStrider provides a contribution report for a git enabled project. This report can be used as a guide to determine a file's owner for code maintenance or reviews.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

GitStrider

Gem Version

GitStrider provides a contribution report for a git enabled project. This report can be used as a guide to determine a file's owner for code maintenance or reviews.

Getting Started

1 - Add GitStrider to your Gemfile and bundle install:

gem 'gitstrider'

2 - Create a rake task

require 'gitstrider'

task :gitstrider do
  # Set the project workspace. If using CI, get the WORKSPACE environment parameter
  workspace = ENV['WORKSPACE']
  
  strider = GitStrider.new workspace, {max_threads: 10}
  
  # Optional - change the report output, default is the one specified below
  # strider.report_path "CodeQualityReports/GitStrider/git_contributions.html"
  
  in1 = "#{workspace}/**/*.h"
  in2 = "#{workspace}/**/*.m"
  strider.include_files [in1, in2]
  
  ex1 = "#{workspace}/Pods/**/*"
  ex2 = "#{workspace}/Dependencies/**/*"
  ex3 = "#{workspace}/UnitTests/**/*"
  ex4 = ".*framework.*"
  strider.exclude_files [ex1, ex2, ex3, ex4]
  
  strider.generate
end

3 - Generate the report by running the task

$ rake gitstrider

Sample Output

sample-report

License

The MIT License (MIT)