https://github.com/kevinsawicki/git-reports

Report generator for Git activity
https://github.com/kevinsawicki/git-reports

Last synced: 26 days ago
JSON representation

Report generator for Git activity

• Host: GitHub
• URL: https://github.com/kevinsawicki/git-reports
• Owner: kevinsawicki
• Created: 2011-12-05T17:31:41.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2012-03-19T22:57:02.000Z (over 12 years ago)
• Last Synced: 2024-10-05T08:04:04.092Z (about 1 month ago)
• Language: Java
• Homepage:
• Size: 217 KB
• Stars: 20
• Watchers: 5
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Git Reports

## Usage

### Release Report

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

```java

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

* [JGit 1.3 Release](http://kevinsawicki.github.com/git-reports/jgit-1.3.html)

* [EGit 1.3 Release](http://kevinsawicki.github.com/git-reports/egit-1.3.html)

* [JGit 1.2 Release](http://kevinsawicki.github.com/git-reports/jgit-1.2.html)

* [EGit 1.2 Release](http://kevinsawicki.github.com/git-reports/egit-1.2.html)

* [Spring Framework 3.1.0 Release](http://kevinsawicki.github.com/git-reports/spring-3.1.0.html)

### Total History Report

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

history

```java

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);

```

#### Example Generated Reports

* [joyent/node master branch](http://kevinsawicki.github.com/git-reports/node.html)

## Dependencies

* [JGit](https://github.com/eclipse/jgit)

* [gitective](https://github.com/kevinsawicki/gitective)

* [Twitter Bootstrap](https://github.com/twitter/bootstrap)

* [FreeMarker](http://freemarker.sourceforge.net/)