Use this project freely as a base for your testable Chef cookbooks.
- Dependency management with Berkshelf.
- Rake, Thor, and Guard tasks for included tools.
- Documentation generation with YARD and knife-cookbook-doc.
- Linting with RuboCop and Foodcritic.
- Unit testing with ChefSpec.
- Integration testing with Test Kitchen.
- Travis CI ready.
- EditorConfig.
- Badges from Shields.io!
This software can be used freely, see The Unlicense. The Apache License text appearing in this software is for demonstration purposes only and does not apply to this software.
-
Clone this repository or download a release.
- The
master
branch can be used for making cookbooks under the Apache 2.0 License. - The
copyright
branch can be used for making proprietary cookbooks.
- The
-
Customize
doc/*.md
.- Do not edit
README.md
directly, it will be generated from_README.md.erb
using data frommetadata.rb
, and the.md
files in/doc
. - Replace things marked with
replace_
. - Customize your badges in
doc/badges.md
. - Run
rake readme
.
- Do not edit
-
Everything else that should be filled in before using this skeleton has been marked with the prefix
replace_
. You can replace the placeholder cookbook name and the copyright text with your own using$ git ls-files -z | xargs -0 sed -i 's/replace_cookbook/your_cookbook/g' $ git ls-files -z | xargs -0 sed -i 's/replace_yyyy/yyyy/g' $ git ls-files -z | xargs -0 sed -i 's/replace_name_of_copyright_owner/name_of_copyright_owner/g' $ git ls-files -z | xargs -0 sed -i 's/replace_username/your_username/g' $ git ls-files -z | xargs -0 sed -i 's/replace_repo/your_repo/g'
To see a list of what else still needs to be replaced, run
$ grep -R replace_
Note that CHANGELOG.md
is just a template for this skeleton.
The actual changes for this project are documented in the commit history
and summarized under Releases.
If you want to pull in future updates from this skeleton, you can fetch and merge in changes from this repository.
If this repository is already set as origin
,
rename it to upstream
with
$ git remote rename origin upstream
and then configure your origin
branch as normal.
Otherwise, add this as a new remote with
$ git remote add upstream https://github.com/makenew/chef-cookbook.git
You can then fetch and merge changes with
$ git fetch upstream
$ git merge upstream/master
The chef-cookbook source is hosted on GitHub. To clone the project run
$ git clone https://github.com/makenew/chef-cookbook.git
Please submit and comment on bug reports and feature requests.
To submit a patch:
- Fork it (https://github.com/makenew/chef-cookbook/fork).
- Create your feature branch (
git checkout -b my-new-feature
). - Make changes. Write and run tests.
- Commit your changes (
git commit -am 'Add some feature'
). - Push to the branch (
git push origin my-new-feature
). - Create a new Pull Request.
This is free and unencumbered software released into the public domain.
This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.