qpid-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Keith W <keith.w...@gmail.com>
Subject Re: What is the intended process to publish trunk docbooks to the Qpid website?
Date Fri, 17 Jan 2014 10:46:50 GMT
Hi Justin

I tested your extensions to site's make gen-release (which you
committed at rev 1556392) on an Ubuntu 12  box (like Apache's
buildbots)  with the dependencies described in the README and
encountered no difficulties.  The site trunk documentation renders

I have a couple of remaining questions:

1. For buildbot integration we will need a mechanism for buildbot to
determine if there is work to be done (i.e. a test before it invokes
make gen-release RELEASE=trunk && make render).
Most CI systems I have seen use the result of an 'svn update' and only
go on to call the later build steps if there were changes, but as the
gen-release target currently takes responsibility for the svn
operation, this approach won't fit.

At the moment I think the trigger will need to use a command such as
'svn info http://svn.apache.org/repos/asf/qpid/trunk/qpid
http://svn.apache.org/repos/asf/qpid/proton/trunk' and trigger the
build only if the reported revision has increased since the previous
buildbot invocation.  Did you have any thoughts?

2. scripts/gen-release-books hardcodes a list of books.  The list of
books we will want to
publish will vary over time (for instance I expect we will have a book
for the JMS AMQP 1.0 client).  Is there a way the scripts can change
to accommodate this requirement?  Presumably, the scripts need to
remain compatible with previous releases in order to be able to
republish documentation from older releases.

I don't yet understand the mechanics of how the buildbot performs the
svn commit (which user is used to perform the commit etc).  I'll find

Thanks in advance, Keith.

On 7 January 2014 22:46, Justin Ross <jross@apache.org> wrote:
> On Tue, Dec 31, 2013 at 2:18 PM, Keith W <keith.wall@gmail.com> wrote:
>> Hi Justin,
>> I'd like to utilise http://ci.apache.org/buildbot.html to
>> automatically publish trunk docbooks (with the new styling) to the
>> Qpid website.
>> I've been taking a look around at site, and it is not clear to me how
>> the website rendering system is supposed to work for trunk
>> documentation.  I notice at the moment we have two copies of some
>> books beneath ./docs (both rendered with the old styling).
>> for instance, for Programming in Apache Qpid, I see:
>> http://qpid.apache.org/components/programming/book/index.html
>> http://qpid.apache.org/books/trunk/Programming-In-Apache-Qpid/html/index.html
>> Do you have any pointers please?
>> Thanks in advance, Keith.
> Hi, Keith.
> With revision 1556392, I've adapted the site release scripts to
> generate docs for trunk snapshots.
> These are the commands to generate trunk docs:
>   % make gen-release RELEASE=trunk
>   % make render
>   (Commit)
> I've posted the output for review here:
>   https://people.apache.org/~jross/transom/head/releases/qpid-trunk/index.html
> In order to run the release scripts from the buildbot instances,
> you'll need dependencies such as docbook, various api gen tools, and
> pygments to colorize examples.  I hope you can get all those into the
> buildbot environment, but if not, I can make at least some of them
> into optional dependencies (removing some functionality).
> Justin

To unsubscribe, e-mail: dev-unsubscribe@qpid.apache.org
For additional commands, e-mail: dev-help@qpid.apache.org

View raw message