GitHist

Documentation for GitHist.

This library helps to get file history (Mostly in couple with task-tracker)

For example, I have an Api and want to show tasks history for users

defmodule FooApi do
  use GitHist, filter_by_regex: ~r/JIRA-\d?/

  ...
end

After this module has new method: commit_history

FooApi.commit_history() # =>
[
  "JIRA-1 Initial of Foo API",
  "JIRA-13 Bugfix of method bar",
  ...
  "JIRA-245 New method added - zar"
]

Installation

If available in Hex, the package can be installed by adding git_hist to your list of dependencies in mix.exs:

def deps do
  [
    {:git_hist, "~> 0.1.0"}
  ]
end