wxruby development - Oct 2006 - Nightly automatic documentation generation

Is there a way to have RubyForge run our ''rake html_docs'' on
SVN Head
each night and if successful copy to http://wxruby.rubyforge.org/doc/?

I do not know all the features RubyForge provides to us but this one
would be pretty nice.

Sean

Sean Long wrote:
> Is there a way to have RubyForge run our ''rake html_docs''
on SVN Head
> each night and if successful copy to http://wxruby.rubyforge.org/doc/?
>   
Good idea. I never get round to uploading the revised documentation.

But I don''t think Rubyforge offers a way to do this - they are limited 
user accounts. It''s probably a bit much to ask Tom to run a custom cron
job.

I guess one way for now would be to run the process on a remote server 
which does an svn update, rake html_doc, scp, using someone''s private 
key to authenticate. But it''s a fiddly thing to set up.

alex

Sean Long wrote:
> Is there a way to have RubyForge run our ''rake html_docs''
on SVN Head
> each night and if successful copy to http://wxruby.rubyforge.org/doc/?
>   
As a stop gap, here''s a patch adding a rake task to automate publishing
the documentation to the website. You need to tell it your Rubyforge id.

rake publish_docs RUBYFORGE_USER=johnsmith

alex
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: rakedoc_rb.patch
Url:
http://rubyforge.org/pipermail/wxruby-development/attachments/20061019/123f04fe/attachment.pl

That is a good idea, when I  get some time I will have to try it out.

thanks

Sean

On 10/19/06, Alex Fenton <alex at pressure.to>
wrote:
> Sean Long wrote:
> > Is there a way to have RubyForge run our ''rake
html_docs'' on SVN Head
> > each night and if successful copy to http://wxruby.rubyforge.org/doc/?
> >
> As a stop gap, here''s a patch adding a rake task to automate
publishing
> the documentation to the website. You need to tell it your Rubyforge id.
>
> rake publish_docs RUBYFORGE_USER=johnsmith
>
> alex
>
>
> Index: wxruby2/rake/rakedocs.rb
> ==================================================================> ---
wxruby2/rake/rakedocs.rb    (revision 689)
> +++ wxruby2/rake/rakedocs.rb    (working copy)
> @@ -108,3 +108,18 @@
>  end
>  desc "Tarball the HTML documentation"
>  task :doc_tar_gz => [ doc_tar_gz_package ]
> +
> +# set the rubyforge username for publishing to the website
> +RUBYFORGE_USER = ENV[''RUBYFORGE_USER'']
> +
> +desc ''Publish rendered docs and sources to the wxRuby website,
using scp''
> +task :publish_docs => [ :html_docs ] do | t |
> +  if not RUBYFORGE_USER
> +    raise ''Must specify RUBYFORGE_USER to publish
documents''
> +  end
> +  # the location we are publishing to
> +  dest =
"#{RUBYFORGE_USER}@rubyforge.org:/var/www/gforge-projects/wxruby/doc/"
> +  sh "scp doc/html/*.html #{dest}"
> +  sh "scp doc/html/*.css #{dest}"
> +  sh "scp doc/textile/*.txtl #{dest}"
> +end
>
>
> _______________________________________________
> Wxruby-development mailing list
> Wxruby-development at rubyforge.org
> http://rubyforge.org/mailman/listinfo/wxruby-development
>
>
>