Module | Hoe::Publish |
In: |
lib/hoe/publish.rb
|
Publish plugin for hoe.
announce: | Create news email file and optionally publish docs. |
debug_email: | Generate email announcement file. |
post_blog: | Post announcement to blog. |
publish_docs: | Publish RDoc to `rdoc_locations`. |
ridocs: | Generate ri locally for testing. |
publish_on_announce: | Run publish_docs when you run release. |
blogs: | An array of hashes of blog settings. |
The blogs entry can either look like:
- path: ~/Work/p4/zss/www/blog.zenspider.com/releases type: zenweb cmd: rake sync (optional)
or:
- url: http://example.com/cgi-bin/blog.cgi blog_id: 1 user: username password: passwd extra_headers: blah: whatever
blog_categories | [RW] | Optional: An array of the project‘s blog categories. Defaults to project name. |
local_rdoc_dir | [RW] | Optional: Name of destination directory for RDoc generated files. [default: doc] |
need_rdoc | [RW] |
Optional: Should RDoc and ri generation tasks be defined? [default: true]
Allows you to define custom RDoc tasks then use the publish_rdoc task to upload them all. See also local_rdoc_dir |
rdoc_locations | [RW] |
Optional: An array of remote (rsync) paths to copy rdoc to.
eg: rdoc_locations << "user@server:Sites/rdoc/#{remote_rdoc_dir}" |
remote_rdoc_dir | [RW] | Optional: Name of RDoc destination directory. [default: name] |
rsync_args | [RW] | Optional: Flags for RDoc rsync. [default: "-av —delete"] |