Stove

A utility for releasing and managing Chef Cookbooks. It will:

Tag and push a new release to git
Upload the cookbook to a cookbook share (such as Supermarket)

Why?

Existing tools to package cookbooks (such as Knife Community and knife cookbook site share) require a dependency on Chef. Because of thier dependency on Chef, they enforce the use of a "cookbook repo". Especially with the evolution of Berkshelf, cookbooks are individualized artifacts and are often contained in their own repositories. stove is cookbook-centric, rather than Chef-centric.

Installation

Add Stove to your project's Gemfile:
```
gem 'stove'
```
Run the bundle command to install:
```
$ bundle install --binstubs
```

Configuration

Stove requires your username and private key to upload a cookbook. You can pass these to each command call, or you can set them Stove:

$ stove login --username sethvargo --key ~/.chef/sethvargo.pem

These values will be saved in Stove's configuration file (~/.stove) and persisted across your workstation.

The default publishing endpoint is the Chef Supermarket, but this is configurable. If you want to publish to an internal community site, you can specify the --endpoint value:

$ stove --endpoint https://internal-cookbook-store.example.com

or for a private supermarket using the supermarket cookbook:

$ stove --endpoint https://internal-cookbook-store.example.com/api/v1

Please note: depending on which version of Chef and which version of Supermarket you are running, you may support the new "extended" metadata fields. By default, Stove reads but does not write these new fields when uploading cookbooks because it is not backwards compatible. If you are running Chef 12+ and have the latest version of Supermarket installed, you can specify the --extended-metadata flag to include these values in the generated metadata:

$ stove --extended-metadata

Usage

There are two ways to use Stove. You can either use the stove command directly or use the embedded rake task.

Command

Execute the stove command from inside the root of a cookbook:

$ bin/stove

This will package (as a tarball) the cookbook in the current working directory, tag a new version, push to git, and publish to a cookbook share.

Rake task

If you are familiar with the Bundler approach to publishing Ruby gems, this approach will feel very familiar. Simply add the following to your Rakefile:

require 'stove/rake_task'
Stove::RakeTask.new

And then use rake to publish the cookbook:

$ bin/rake publish

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

License & Authors

Author: Seth Vargo ([email protected])

Copyright 2013-2014 Seth Vargo <[email protected]>
Copyright 2013-2014 Chef Software, Inc

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.