forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Leo Simons <leosim...@apache.org>
Subject Re: basic forrest plugin for maven
Date Mon, 02 Jun 2003 17:42:03 GMT
It's been suggested this thing should be further developed and hosted 
here. Currently looking at the forrest cvs module and figuring out how 
to patch what.....

cheers!

- Leo

Leo Simons wrote:
> Hi gang,
> 
> I've written a very basic forrest plugin:
> 
> http://cvs.apache.org/~leosimons/maven-forrest-plugin.zip (12 megs!)
> 
> I've copied over a forrest snapshot build from feb 19 into the 
> plugin-resources directory, tweaked the forrest.build.xml file (see the 
> forrest.build.xml.patch.txt), added a plugin.properties, 
> project.properties, then added a minimal plugin.jelly script which just 
> calls the ant buildfile.
> 
> ---
> 
> You can see it in use in the avalon-excalibur cvs:
> 
> 1 - install maven beta 9 (or later, probably)
> 2 - unzip the plugin into your maven plugins/ dir
> 3 - checkout the avalon and avalon-excalibur cvses
> 4 - cd avalon-excalibur/compatibility
> 5 - maven xdoc
> 
> Current usage:
> 
>     <postGoal name="xdoc">
>         <attainGoal name="forrest:generate"/>
>     </postGoal>
> 
> or call "maven forrest:generate" directly.
> 
> ---
> 
> I am sure there is a better way to do this, but given the lack of plugin 
> writing docs this was the easiest thing I could figure out that would 
> make things work.
> 
> Is there interest in improving this? Anyone want to help out here? I 
> think most of the things that need doing are just an hour of two of work 
> for those among you who know maven well :D
> 
> ---
> 
> Partial todo
> ------------
> - add plugin to forrest cvs or maven cvs (which one?)
> 
> - figure out a full POM for forrest and list all of its dependencies 
> (the gump descriptor should be a good start)
> 
> - patch the most recent forrest install buildfile as I did (really 
> minimal changes only, in fact)
> 
> - patch the buildfile to customize the classpath to reference 
> dependencies in the repository, rather than include a whole bunch of 
> jars in the plugin; remove all the jars
> 
> - properly structure the plugin so that it adheres to maven plugin 
> conventions and things like a manifest are auto-generated
> 
> - remove unused stuff like the webapp and forrestbot functionality from 
> the plugin
> 
> - figure out how to neatly replace the xdoc generation (right now the 
> forrest:generate target just overwrites any maven-generated files which 
> are in the way)
> 
> - customize forrest skins to include a reference to the maven-generated 
> project reports if they exist
> 
> - write a project.xml (maven POM) -> status.xml (Forrest status file) 
> converter
> 
> - perhaps write an all-new doc generation plugin where it is easier to 
> customize whether JSL or forrest or something else is used?
> 
> ---
> 
> cheers,
> 
> - Leo



Mime
View raw message