README.md in vendorificator-0.2.0 vs README.md in vendorificator-0.3.0
- old
+ new
@@ -48,12 +48,14 @@
Most important commands are listed here; use `vendor help` for more
detail.
* `vendor sync` will update all vendor modules that need updating
* `vendor status` will list all the modules and their status
- * `vendor pull` will pull all vendor branches, tags, and notes from a
- Git remote
+ * `vendor pull` will pull all vendor branches, tags, and notes from
+ a Git remote
+ * `vendor push` will push all vendor branches, tags, and notes to
+ a Git remote
* `vendor diff` will show the differences between vendor module's
pristine branch and curent work tree
* `vendor log` will show a `git log` of all changes made to a particular
vendor module's files that are not in module's pristine branch
@@ -121,13 +123,13 @@
block).
Example:
```ruby
-vendor 'generated', :version => '0.23' do |mod|
- File.open('README') { |f| f.puts "Hello, World!" }
- File.open('VERSION') { |f| f.puts mod.version }
+vendor 'generated', :version => '0.23' do |v|
+ File.open('README', 'w') { |f| f.puts "Hello, World!" }
+ File.open('VERSION', 'w') { |f| f.puts v.version }
end
```
#### download
@@ -158,11 +160,11 @@
* `:no_strip_root` -- by default, if archive consists of a single
directory, Vendorificator will strip it. Setting this to true
disables this behaviour.
* `:checksum` -- if set to SHA256 checksum of the file, it will be
checked on download.
-
+
Archive's `:version` defaults to file name.
Example:
```ruby
@@ -179,14 +181,15 @@
* `:repository` -- address of the repository. Defaults to name (and
sets name to its basename then), just like `:url` for `archive`
(e.g. `git "git://github.com/github/testrepo.git"` will be cloned
from that repository, and named `testrepo`).
- * `:branch`, `:revision` -- what to check out when repository is
- cloned.
+ * `:branch`, `:revision`, `:tag` -- what to check out when repository
+ is cloned.
-Git module's `:version` defaults to the conjured revision.
+Git module's `:version` defaults to the `:tag` if given, or the
+conjured revision otherwise.
Example:
```ruby
git 'git://github.com/mpasternacki/nagios.git',
@@ -206,11 +209,11 @@
* `:ignore_dependencies` -- if true, ignore dependencies
completely. If an array, don't download dependencies that are in
the array. Default for that is `chef_cookbook_ignore_dependencies`
setting.
-
+
Examples:
```ruby
chef_cookbook 'apt'
chef_cookbook 'memcached'
@@ -225,20 +228,18 @@
```ruby
chef_cookbook 'memcached', ignore_dependencies => ['runit']
```
If you get Chef cookbooks from Git or anywhere else than Opscode's
-community website, you can still use dependency resolution by mixing
-in the hook class:
+community website, you can still use dependency resolution by using a :hooks
+option to add it:
```ruby
-class << git 'git://github.com/user/cookbook.git', :category => :cookbooks
- include Vendorificator::Hooks::ChefCookbookDependencies
+git 'git://github.com/user/cookbook.git',
+ :category => :cookbooks,
+ :hooks => 'ChefCookbookDependencies'
end
```
-
-This is a bit convoluted, but there will soon be an argument to do
-that in a nicer way.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)