A configurable tool to track work effort by committers on Git and Subversion repositories, Excel sheets, and CSV files.
Spiritual successor to svntime
- Ruby 2.6+ or 3.0+
gitif you want to use git sourcessvnif you want to use subversion sources
bundle install
bundle exec ruby generate.rb --config path/to/config.yml
Will generate the following files:
| Filename | Description |
|---|---|
revisions.csv |
An unfiltered list of all data points (revisions) |
revisions-with-authors.csv |
Filtered with authors: config below, and duplicate entries removed |
blocks.csv |
Author-filtered revisions, before and after applied to each date, and contiguous blocks are merged; may span multiple months |
blocks-by-month.csv |
Blocks split across month boundaries |
work-by-month.csv |
The number of seconds in each block, per month and per author |
authors.csv |
All identified authors, including any filtered out using any authors: config |
You can create a new config file by using the --init flag, or copy the sample file below.
# Each source can have a default before/after set
default_source:
before: 1 hour
after: 1 hour
# List all the different sources you want to parse
# Available sources:
# - git
# - svn
# - xls
# - csv
# - ical
sources:
-
git: https://github.com/soundasleep/gittime
# You can customise before/after here, based on your commit style:
before: 2 hours
after: 30 seconds
# You can select only commits that match a path (each of these are a regexp):
# only:
# - \.github/
# - README.*
-
svn: https://svn.riouxsvn.com/gittime-example
-
xls: excel.xls
# You can specify a fallback author if any field is empty:
fallback:
author: anonymous
-
csv: sample.csv
fixed:
author: jevon.wright
-
ical: https://raw.githubusercontent.com/soundasleep/gittime/refs/heads/main/spec/integration/sample.ics
# With calendar events, you can ignore or require events that match any regexp in the message or description
only:
- christmas
ignore:
- after
# ... add more as necessary
# Different sources may have different ways of expressing
# authors. Use this to map source authors to a consistent author label.
# Case insensitive, and you can use regular expressions here.
authors:
jevon:
- jevon.*
- Jevon.*
# ... add more as necessary
# You can restrict reporting for only specific author labels:
# only:
# authors:
# - jevon
# For more complex setups, you can merge multiple files together.
# Each file is loaded and deep merged, but has the same schema as your config.yml.
# merge:
# - .file1.yml
# - .file2.ymlOnly .xls is supported, not .xlsx: see spreadsheet gem
Each worksheet in the file must have a header row. For the best success, provide the following header rows:
Modified byModified atMessagePath
You can define "environment" variables in a secondary YAML file through the command-line option --env.
For example, by defining an environment variable file .env.yml with the following contents:
token: gh_abc
username: jevonIf gittime is run with --env .env.yml, these variables will be inserted into a
config file like the following (using simple string substitution):
sources:
-
git: https://${{ token }}@github.com/soundasleep/gittime
authors:
jevon:
- ${{ username }}.*bundle exec rake