Git Reports

Usage

Release Report

The following snippet creates a report between two releases (1.1 & 1.2)

ReleaseReport report = new ReleaseReport();
report.setProjectName("EGit");
report.setProjectVersion("1.2");

GitHubLinker linker = new GitHubLinker();
linker.setBase("https://github.com/eclipse/egit");
report.setLinker(linker);

String current = "remotes/origin/stable-1.2";
String previous = "remotes/origin/stable-1.1";

Repository repo = new FileRepository("/repos/egit/.git");
RevCommit base = CommitUtils.getBase(repo, current, previous);
report.run(repo, current, base.name());

Template tpl = Templates.getTemplate("release");
tpl.setOutputEncoding("UTF-8");
FileWriter writer = new FileWriter("/reports/egit.html");
tpl.process(report, writer);

Example Generated Reports

Total History Report

The following snippet creates a comprehensive reports of a repository's entire history

TotalHistoryReport report = new TotalHistoryReport();
report.setProjectName("node");
report.setProjectVersion("master branch");

GitHubLinker linker = new GitHubLinker();
linker.setBase("https://github.com/joyent/node");
report.setLinker(linker);

Repository repo = new FileRepository("/repos/node/.git");
report.run(repo, "master");

Template tpl = Templates.getTemplate("total-history");
tpl.setOutputEncoding("UTF-8");
FileWriter writer = new FileWriter("/reports/node.html");
tpl.process(report, writer);