chatops_notify (1) Versions 1.0.0 Follow0

Installs/Configures chatops-notify

Policyfile

Berkshelf

Knife

cookbook 'chatops_notify', '~> 1.0.0', :supermarket

cookbook 'chatops_notify', '~> 1.0.0'

knife supermarket install chatops_notify

knife supermarket download chatops_notify

README

Dependencies

Changelog

Quality 33%

chatops_notify Cookbook

This is a library cook that provides a resource to notify your favourite chatops platform.

In scope

This cookbook focuses on providing a resource to send messages to your chatops platform. See listed chat platform under 'Supports' section.

Out of scope

This cookbook does not install the chat platform or any other components.

Supports

Slack
Hipchat

Usage

Add cookbook as a dependncy in metadata.rb

depends 'chatops_notify'

Resources

`Slack`

Actions

:notify - Default value for all

Parameters

'channel' The required Slack channel, default: nil
'webhook' The Slack webhook, default: nil
'username' Name message appears from in Slack, default: 'chef-client'
'message' The message text to send to Slack, default: nil
'icon_emoji' The emoticon to use in Slack, default ':fork_and_knife:'

Example

chatops_notify 'Description' do
  chat_platform :slack
  channel 'test'
  username 'Chef'
  webhook 'https://slack.webhook.url'
  message 'My mesage that appears in Slack'
end

`Hipchat`

Parameters

'webhook' The Hipchat webhook, default: nil
'message' The message text to send to Hipchat, default: nil

Example

chatops_notify 'Description' do
  chat_platform :hipchat
  webhook 'https://hipchat.webhook.url'
  message 'My mesage that appears in Hipchat'
end

`Custom`

Parameters

'webhook' The custom endpoint to send message to, default: nil
'body' The payload to send to the endpoint, default: nil

Example

chatops_notify 'Description' do
  chat_platform :custom
  webhook 'https://custom.webhook.url'
  body 'payload expected by endpoint'
end

Contributing

Fork the repository on Github
Create a named feature branch (like add_chatops_client_x)
Write your change
Write tests for your change (if applicable)
Run the tests, ensuring they all pass
Submit a Pull Request using Github

License and Authors

Authors: Nielsen Pierce (nielsen.pierce@rackspace.co.uk)

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

chatops-notify CHANGELOG

This file is used to list changes made in each version of the chatops-notify cookbook.

1.0.0

[Nielsen Pierce] - Release 1.0.0 of chatops-notify

Check the Markdown Syntax Guide for help with Markdown.

The Github Flavored Markdown page describes the differences between markdown on github and standard markdown.

Collaborator Number Metric

1.0.0 failed this metric

Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric

1.0.0 passed this metric

No Binaries Metric

1.0.0 passed this metric

Testing File Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Chef Supermarket

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

chatops_notify (1) Versions 1.0.0 Follow0

chatops_notify Cookbook

In scope

Out of scope

Supports

Usage

Resources

`Slack`

Actions

Parameters

Example

`Hipchat`

Parameters

Example

`Custom`

Parameters

Example

Contributing

License and Authors

Dependent cookbooks

Contingent cookbooks

chatops-notify CHANGELOG

1.0.0

Collaborator Number Metric

1.0.0 failed this metric

Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric

1.0.0 passed this metric

No Binaries Metric

1.0.0 passed this metric

Testing File Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Details

Updated May 20, 2015 Created on May 20, 2015

Supported Platforms

License

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

Select Badges

Select Supported Platforms

Select Status

chatops_notify (1) Versions 1.0.0 1.0.0 Follow0

chatops_notify Cookbook

In scope

Out of scope

Supports

Usage

Resources

Slack

Actions

Parameters

Example

Hipchat

Parameters

Example

Custom

Parameters

Example

Contributing

License and Authors

Dependent cookbooks

Contingent cookbooks

chatops-notify CHANGELOG

1.0.0

Collaborator Number Metric 1.0.0 failed this metric Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric 1.0.0 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric 1.0.0 passed this metric

No Binaries Metric 1.0.0 passed this metric

Testing File Metric 1.0.0 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric 1.0.0 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Details

Updated May 20, 2015 Created on May 20, 2015

Supported Platforms

License

chatops_notify (1) Versions 1.0.0 Follow0

`Slack`

`Hipchat`

`Custom`

Collaborator Number Metric

1.0.0 failed this metric

Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric

1.0.0 passed this metric

No Binaries Metric

1.0.0 passed this metric

Testing File Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number