README.md
Webhook Cookbook
================
[][cookbook]
[][travis]
[][codeclimate]
[][coveralls]
[cookbook]: https://supermarket.getchef.com/cookbooks/webhook
[travis]: http://travis-ci.org/RoboticCheese/webhook-chef
[codeclimate]: https://codeclimate.com/github/RoboticCheese/webhook-chef
[coveralls]: https://coveralls.io/r/RoboticCheese/webhook-chef
A cookbook for installing and configuring the various components of
[Webhook](http://www.webhook.com).
Requirements
------------
See each recipe's notes below for platform-specific limitations.
Usage
-----
This cookbook can be implemented either by calling its resource directly, or
adding the recipes that wrap it to your run_list.
Recipes
-------
***default***
***cli***
Installs Node.js and calls the webhook_cli resource to install the Webhook CLI.
Due to current limitations of the nodejs cookbook, this recipe is Linux-only.
***app***
Calls the webhook_app resource to install the (beta) Webhook GUI app.
The app is distributed only for OS X and Windows, so this recipe is limited to
those platforms. Package upgrade and removal on both platforms is wonky at best
and unavailable to Chef at worst, so the best way for now to do either action
is manually.
Attributes
----------
***default***
| Attribute | Default | Description |
|-------------------------------------------|---------|---------------------------------------------------------------------|
| `node['webhook']['cli']['version']` | nil | Install a specific version of the Webhook CLI instead of the latest |
| `node['webhook']['cli']['grunt_version']` | nil | Install a specific version of Grunt instead of the latest |
| `node['webhook']['app']['package_url']` | nil | Grab the Webhook app package from a specific URL |
Resources
---------
***webhook_cli***
Wraps the installation of Grunt and the Webhook CLI NPM packages into a single
resource.
Syntax:
webhook_cli 'webhook' do
version '1.2.3'
grunt_version '4.5.6'
action :install
end
Actions:
| Action | Description |
|--------------|-----------------------------------|
| `:install` | Install the Webhook CLI (default) |
| `:uninstall` | Uninstall the CLI |
Attributes:
| Attribute | Default | Description |
|-----------------|------------|--------------------------------------|
| `version` | `'latest'` | Version of the wh package to install |
| `grunt_version` | `'latest'` | Version of the Grunt dep to install |
***webhook_app***
Downloads and installs the packaged Webhook app (currently for OS X and Windows
only).
Syntax:
webhook_app 'webhook' do
package_url 'https://path.to/somewhere'
action :install
end
Actions:
| Action | Description |
|--------------|-----------------------------------|
| `:install` | Install the Webhook app (default) |
Attributes:
| Attribute | Default | Description |
|-----------------|------------|--------------------------------------|
| `package_url` | `nil` | Grab the package from a custom URL |
Providers
---------
***webhook_cli***
Handles installs/uninstalls of the Webhook CLI, via NPM packages.
***webhook_app***
Handles installs of the Webhook app, via system packages.
Contributing
------------
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Run style checks and RSpec tests (`bundle exec rake`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create new Pull Request
License & Authors
-----------------
- Author: Jonathan Hartman <j@p4nt5.com>
Copyright 2014, Jonathan Hartman
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.