knife-spork-berks 1.3.2

data/plugins/Foodcritic.md

@@ -0,0 +1,53 @@
+Foodcritic
+==========
+Automatically runs foodcritic against your cookbooks on check and upload.
+
+Gem Requirements
+----------------
+This plugin requires the following gems:
+
+```ruby
+gem 'foodcritic' >= 3.0.0
+```
+
+Hooks
+-----
+- `after_check`
+- `before_upload`
+
+Configuration
+-------------
+```yaml
+plugins:
+  foodcritic:
+    tags:
+      - FC0023
+    fail_tags:
+      - any
+    include_rules:
+      - foodcritic/etsy
+    epic_fail: true
+```
+
+#### tags
+The tags to check against.
+
+- Type: `Array`
+- Default: '[any]'
+
+#### fail_tags
+The list of tags to fail on.
+
+- Type: 'Array'
+- Default: '[any]'
+
+#### include_rules
+An optional list of additional rules to run.
+
+- Type: `Array`
+
+#### epic_fail:
+If set to true, `epic_fail` will prevent you from uploading a cookbook until all foodcritic rules pass.
+
+- Type: `Boolean`
+- Default: `true`

data/plugins/Git.md

@@ -0,0 +1,46 @@
+Git
+===
+This plugin attempts to help manage your workflow by automatically pulling changes from your repo. **Do not use this plugin if you are not using Git.**
+
+Gem Requirements
+----------------
+This plugin requires the following gems:
+
+```ruby
+gem 'git'
+```
+
+Hooks
+-----
+- `before_bump`
+- `after_bump`
+- `after_promote`
+
+Configuration
+-------------
+```yaml
+plugins:
+  git:
+    remote: origin
+    branch: master
+```
+
+**Note** Due to the nature of the git plugin, it's possible that you accept all the defaults. In that case, you should make your configuration like this:
+
+```yaml
+plugins:
+  git:
+    enabled: true
+```
+
+#### remote
+The git remote to push/pull to/from.
+
+- Type: `String`
+- Default: `origin`
+
+#### branch
+The git branch to push/pull to/from.
+
+- Type: `String`
+- Default: `master`

data/plugins/Graphite.md

@@ -0,0 +1,30 @@
+Graphite
+========
+Graphite will automatically send a request to your Graphite server under the deploys.chef.[environment] for graphical analysis.
+
+Gem Requirements
+----------------
+This plugin has no gem requirements.
+
+Hooks
+-----
+- `after_promote`
+
+Configuration
+-------------
+```yaml
+plugins:
+  graphite:
+    server: graphite.example.com
+    port: 12345
+```
+
+#### server
+The url to the graphite server
+
+- Type: `String`
+
+#### port
+The port of the graphite server
+
+- Type: `Integer`

data/plugins/Grove.md

@@ -0,0 +1,31 @@
+Campfire
+========
+Automatically posts informational messages to Grove.io
+
+Gem Requirements
+----------------
+This plugin requires the following gems:
+
+```ruby
+gem 'rest_client'
+```
+
+Hooks
+-----
+- `after_promote`
+- `after_upload`
+
+Configuration
+-------------
+```yaml
+plugins:
+  grove:
+    tokens:
+      - ABC
+      - XYZ
+```
+
+#### Tokens
+This is an array of tokens (channels) to post messages to.
+
+- Type: `String`

data/plugins/HipChat.md

@@ -0,0 +1,50 @@
+HipChat
+=======
+HipChat posts messages to your HipChat client.
+
+Gem Requirements
+----------------
+This plugin requires the following gems:
+
+```ruby
+gem 'hipchat'
+```
+
+Hooks
+-----
+- `after_upload`
+- `after_promote`
+
+Configuration
+-------------
+```yaml
+plugins:
+  hipchat:
+    api_token: ABC123
+    rooms:
+      - General
+      - Web Operations
+    notify: true
+    color: yellow
+```
+
+#### api_token
+Your HipChat API token.
+
+- Type: `String`
+
+#### rooms
+The list of rooms to post to.
+
+- Type: `Array`
+
+#### notify
+Boolean value indicating whether the room should be notified.
+
+- Type: `Boolean`
+
+#### color
+THe color of the message.
+
+- Type: `String`
+- Acceptable Values: `[yellow, red, green, purple, random]`

data/plugins/Irccat.md

@@ -0,0 +1,50 @@
+Plugin Name
+===========
+This plugin interfaces with the irccat IRC bot (https://github.com/RJ/irccat)
+
+Gem Requirements
+----------------
+This plugin has no gem requirements.`
+
+Hooks
+-----
+- `after_promote`
+
+Configuration
+-------------
+```yaml
+plugins:
+  irccat:
+    server: irc.example.com
+    port: 54
+    channels:
+      - #chef
+      - #knife
+    gist: "/usr/bin/gist"
+    template:
+          upload: "foo bar! #REDCHEF:#NORMAL %{organization}%{current_user} uploaded #GREEN%{cookbooks}#NORMAL"
+```
+
+#### server
+The url of the IRC server.
+
+- Type: `String`
+
+#### port
+The port of the IRC server.
+
+- Type: `String`
+
+#### channels
+The channels to post to.
+
+- Type: `Array`
+
+#### gist
+Optional path to gist binary installed by https://rubygems.org/gems/gist
+
+- Type: `String`
+
+
+### template
+Optional irccat message template if you want to change the formatting of irccat alerts. Supports overriding alerts for upload and promote

data/plugins/Jabber.md

@@ -0,0 +1,61 @@
+Jabber
+=======
+Jabber posts messages to a designated Jabber group chat room.
+
+Gem Requirements
+----------------
+This plugin requires the following gems:
+
+```ruby
+gem 'xmpp4r'
+```
+
+Hooks
+-----
+- `after_upload`
+- `after_promote`
+
+Configuration
+-------------
+```yaml
+plugins:
+  jabber:
+    username: YOURUSER
+    password: YOURPASSWORD
+    nickname: Chef Bot
+    server_name: your.jabberserver.com
+    server_port: 5222
+    rooms:
+      - engineering@your.conference.com/spork
+      - systems@your.conference.com/spork
+```
+
+#### username
+Your Jabber username.
+
+- Type: `String`
+
+#### password
+Your Jabber password.
+
+- Type: `String`
+
+#### nickname
+A nickname to use in the conference room when making announcements.
+
+- Type: `String`
+
+#### server_name
+Your Jabber server name.
+
+- Type: `String`
+
+#### server_port
+Your Jabber server port number. Default: 5222
+
+- Type: `String`
+
+#### rooms
+The list of rooms to post to.
+
+- Type: `Array`

data/plugins/README.md

@@ -0,0 +1,70 @@
+Plugins Directory
+=================
+This folder contains relevant documentation for each KnifeSpork plugin. For more information, usage, and options for an particular plugin, click on the assoicated markdown file in the tree above.
+
+Creating a Plugin
+-----------------
+To create a plugin, start with the following basic boiler template:
+
+```ruby
+require 'knife-spork/plugins/plugin'
+
+module KnifeSpork
+  module Plugins
+    class MyPlugin < Plugin
+      name :my_plugin
+
+      def perform
+        # your plugin code here
+      end
+    end
+  end
+end
+```
+
+**Don't forget to update the class name and the `name` at the very top of the class!**
+
+Helpers
+-------
+The following "helpers" or "methods" are exposed:
+
+#### safe_require
+This method allows you to safely require a gem. This is helpful when your plugin requires an external plugin. It will output a nice error message if the gem cannot be loaded and stop executing.
+
+#### current_user
+This method tries to get the current user's name in the following manner:
+
+1. From the git configuration
+2. From the `ENV`
+
+#### config
+This method returns the config associated with the current plugin. For example, if a `spork-config.yml` file looked like this:
+
+```yaml
+plugins:
+  my_plugin:
+    option_1: my_value
+    option_2: other_value
+```
+
+then
+
+```text
+config.option_1   #=> 'my_value'
+config.option_2   #=> 'other_value'
+```
+
+This uses `app_conf`, so you access the keys are methods, not `[]`.
+
+#### cookbooks
+This returns an array of `Chef::CookbookVersion` objects corresponding to the cookbooks that are being changed/altered in the hook. For more information on the methods avaliable, see the [file in the Chef repo](https://github.com/opscode/chef/blob/master/chef/lib/chef/cookbook_version.rb).
+
+#### environments
+This returns an array of `Chef::Environment` objects corresponding to the environments that are being changed/altered in the hook. For more information on the methods avaliable, see the [file in the Chef repo](https://github.com/opscode/chef/blob/master/chef/lib/chef/environment.rb).
+
+#### environment_diffs
+This returns a Hash of Hash objects containing a diff between local and remote environment for each environment changed/altered in the hook. Currently, this will only be populated during the promotea action. 
+
+
+#### ui
+This returns a `Chef::Knife::UI` element for outputting to the console. For more information on the methods avaliable, see the [file in the Chef repo](https://github.com/opscode/chef/blob/master/chef/lib/chef/knife/core/ui.rb).

data/plugins/StatusNet.md

@@ -0,0 +1,41 @@
+StatusNet
+=======
+StatusNet posts messages to a your StatusNet instance
+
+Gem Requirements
+----------------
+This plugin requires the following gems:
+
+```ruby
+gem 'curb'
+```
+
+Hooks
+-----
+- `after_upload`
+- `after_promote`
+
+Configuration
+-------------
+```yaml
+plugins:
+  statusnet:
+    url: YOUR INSTANCE API URL
+    username: YOURUSER
+    password: YOURPASSWORD
+```
+
+#### url
+Your StatusNet instance API url, usually server url + /api/statuses/update.xml
+
+- Type: `Srtring`
+
+#### username
+Your StatusNet username.
+
+- Type: `String`
+
+#### password
+Your StatusNet password.
+
+- Type: `String`

data/plugins/Template.md

@@ -0,0 +1,34 @@
+Plugin Name
+===========
+Here is an optional, short description about your plugin.
+
+Gem Requirements
+----------------
+This plugin requires the following gems:
+
+```ruby
+gem 'my_gem', '~> 1.4.5'
+gem 'other_gem', '>= 5.0.1'
+```
+
+Hooks
+-----
+- `after_promote`
+
+Configuration
+-------------
+```yaml
+plugins:
+  plugin_name:
+    option_1: true
+    option_2:
+      - a
+      - b
+      - c
+```
+
+#### option_1
+This is a description of the option.
+
+- Type: `String`
+- Default: `ABC`