git-commit-standup

Hard to remember yesterday when it's standup time. Always be prepared with > standup

Install

yarn global add git-commit-standup

# or with npm

npm install -g git-commit-standup

Basic usage

$ standup --authors [email protected]

~/repos/frontend
d25b960 #9 Support --since thismonth|lastmonth
d12f92e #7 Support repositories key in config file
7c5da83 #7 Add support for multiple repos

~/repos/backend
964bd3f #7 Add typing to report output
4f589ee #7 Add ability to filter by author
99817d0 #8 Read and use config from ~/.timesheetrc
fa2889a #8 Add type for HomeDirectoryConfig
fdda89c #8 Add code to read json config from home directory

The script will automatically assume a 5 day workweek, Monday - Friday. If the script is run on Monday, it will show any commits since Friday (last 72 hours). Otherwise, it'll show commits from the last 24 hours.

Clean commit messages is obviously an advantage.

Options

Usage: standup [options]

Options:
  -V, --version                         output the version number
  -a, --authors [[email protected]]       Only care about commits from these
                                        emails.
  -s, --since [date]                    Analyze data since date (including).
                                        [today|lastweek|thismonth|yyyy-mm-dd]
                                        [default: lastworkday]
  -u, --until [date]                    Analyze data until date (excluding).
                                        [today|lastweek|thismonth|yyyy-mm-dd]
                                        [default: now]
  -r, --repositories [path,other-path]  Git repositories to analyze.
                                        [default: .]
  -e, --email [emailOther=emailMain]    Group person by email.
  -m, --merge-request [false|true]      Include merge requests into
                                        calculation.
                                        [default: true]
  -i, --ignore-standuprc                Ignores .standuprc from home
                                        directory.
                                        [default: false]
  -j, --json                            Reports in JSON format.
                                        [default: false]
  -v --verbose                          Prints extra stats
                                        [default: false]
  -D --debug                            Prints debug information
                                        [default: false]
  -h, --help                            display help for command

  Examples:

  - Show commits made last workday until today (author taken from git config)

   $ timesheet

  - Show commits from last workday by [email protected]

   $ timesheet -a [email protected]

Config

.standup config

By default, the repository parameter will check the current git repository. You can also summarize multiple repositories by adding a config file to your home folder.

The config has the following structure:

{
  "repositories": [
    "/Users/tomfa/repos/notes",
    "/Users/tomfa/repos/app",
    "/Users/tomfa/repos/backend"
  ],
  "authors": ["[email protected]"],
  "emailAliases": {
    "[email protected]": "[email protected]",
    "[email protected]": "[email protected]"
  }
}

The config above will look for commits in three different locations, made by [email protected], [email protected] and [email protected].

Roadmap

#1: Pulling down issue info from issue tracker

If you commit with references to an issue tracker, e.g. #1 my commit message, the script can connect and pull down information on those