Sha256: 36c7432fd457d311bda4e74d91a238e578ba4d7ca48ed9b5b644d3f5763d54d5

Contents?: true

Size: 1.48 KB

Versions: 1

Compression:

Stored size: 1.48 KB

Contents

# lita-github-commits

[![Build Status](https://travis-ci.org/webdestroya/lita-github-commits.png)](https://travis-ci.org/webdestroya/lita-github-commits)
[![Code Climate](https://codeclimate.com/github/webdestroya/lita-github-commits.png)](https://codeclimate.com/github/webdestroya/lita-github-commits)
[![Coverage Status](https://coveralls.io/repos/webdestroya/lita-github-commits/badge.png)](https://coveralls.io/r/webdestroya/lita-github-commits)

**lita-github-commits** is a handler for [Lita](https://github.com/jimmycuadra/lita) that listens for github commits and posts them in the channel.

## Installation

Add lita-github-commits to your Lita instance's Gemfile:

``` ruby
gem "lita-github-commits"
```

## Configuration

### Required attributes

* `repos` (Hash) - A map of repositories to allow notifications for and the chat rooms to post them in. The keys should be strings in the format "github_username/repository_name" and the values should be either a string room name or an array of string room names. Default: `{}`.

### Example

``` ruby
Lita.configure do |config|
  config.handlers.github_commits.repos = {
    "username/repo1" => "#someroom",
    "username/repo2" => ["#someroom", "#someotherroom"]
  }
end
```

**Note**: For HipChat, the room should be the JID of the HipChat room (eg. `123_development@conf.hipchat.com`)

## Usage

You will need to add a GitHub Webhook url that points to: `http://address.of.lita/github-commits`

## License

[MIT](http://opensource.org/licenses/MIT)

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
lita-github-commits-0.1.0 README.md