rack-commit-stats

rack-commit-stats is a Rack application that will display information about the commit at a Git repository's HEAD. It's primary use case is for mounting within another Rack-based application to display a quickly accessible digest of commit information for that app; this is useful to quickly see what branch and commit are deployed to your server environments if you don't have other tooling already set up for that purpose.

Getting Started

Add the gem to your Gemfile and run bundle install:

gem 'rack-commit-stats'

An important note: this gem is built on top of Rugged, which requires CMake to be present on your system. CMake should be available through your package manager of choice.

For Rails

Mount the application on a new endpoint within your routes.rb file. You will probably want to limit access to this endpoint using some sort of authentication constraint you've established, though this is totally optional.

mount RackCommitStats::App => '/deploy',
  constraints: YouShallNotPassConstraint.new

A Railtie is provided, so no additional configuration is required unless your .git directory is on a non-standard path. If it is, you can set the path in the affected environment configuration files.

# production.rb
config.rack_commit_stats.repo_path = '../repo'

For Sinatra

Simply add a new route with an endpoint of your choice and call the application from inside of it.

get '/deploy' do
  RackCommitStats::App.call env
end

Additionally, you can configure the Git repository path if you're not using the standard .git directory or your app isn't being run from the repository root.

RackCommitStats.configure do |config|
  config.repo_path = '../.git'
end

Example Output

{
  "branch": "master",
  "commit": {
    "revision": "5ec0b96f8304cc9487172375a6f953cc73d3ffd5",
    "message": "I have a lovely bunch of coconuts.",
    "author": {
      "name": "Foo Bar",
      "email": "[email protected]"
    }
  }
}

rack-commit-stats

Getting Started

For Rails

For Sinatra

Example Output

License