Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

chatops_notify (1) Versions 1.0.0

Installs/Configures chatops-notify

Berkshelf/Librarian
Policyfile
Knife
cookbook 'chatops_notify', '~> 1.0.0'
cookbook 'chatops_notify', '~> 1.0.0', :supermarket
knife cookbook site install chatops_notify
knife cookbook site download chatops_notify
README
Dependencies
Changelog
Quality 44%

Circle CI

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

  1. Fork the repository on Github
  2. Create a named feature branch (like add_chatops_client_x)
  3. Write your change
  4. Write tests for your change (if applicable)
  5. Run the tests, ensuring they all pass
  6. 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

License Metric
            

1.0.0 passed this metric

No Binaries Metric
            

1.0.0 passed this metric

Publish Metric
            

1.0.0 passed this metric

Supported Platforms Metric
            

1.0.0 failed this metric

chatops_notify should declare what platform(s) it supports.

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