https://github.com/restorando/capistrano-hipchat

Capistrano plugin to notify deployments on HipChat
https://github.com/restorando/capistrano-hipchat

Last synced: about 1 month ago
JSON representation

Capistrano plugin to notify deployments on HipChat

• Host: GitHub
• URL: https://github.com/restorando/capistrano-hipchat
• Owner: restorando
• License: mit
• Created: 2013-12-26T15:59:45.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2015-10-15T14:51:23.000Z (about 9 years ago)
• Last Synced: 2024-04-20T17:43:21.767Z (8 months ago)
• Language: Ruby
• Size: 214 KB
• Stars: 5
• Watchers: 31
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Capistrano::Hipchat

Notifies in a hipchat room about a new deployment showing the git log

for the latests commits included in the current deploy.

## Installation

Add this line to your application's Gemfile:

    group :deployment do

      gem 'capistrano-hipchat'

    end

The group declaration is optional, but it's important to make sure you only load this gem within a Capistrano script

(as explained below) and never within your application (eg. rails does the require of the default bundler group and

the current environment group.

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install capistrano-hipchat

## Usage

Add this to your `Capfile`

```ruby

require 'capistrano/hipchat'

```

Then you need to configure your hipchat token and the room you want to notify

about the new deployment

```ruby

set :hipchat_token, "YOUR TOKEN"

set :hipchat_room_name, "Hackers"

```

To known who is deploying capistrano-hipchat relies on the custom variable

`local_user`, you can set it like this

```ruby

set :local_user, "deployer"

```

You can also configure:

- :hipchat_bot_name (default: Deployer)

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request