[jboss-as7-dev] packaging of demos in AS7

[Max Rydahl Andersen]

> Perhaps I didn't make the situation sufficiently clear. I'm not setting out to write a new quickstart for AS. I already have a demo app. It already has version control, in the JBossTS repository. It already has documentation, in the JBossTS manuals. It already has a build script.

Maven or Ant ?

> What I'm interested in is how to inject these pre-existing assets into the AS build and hence release bundle, with the minimum of upstream changes. If the only way to do that is to fork them into the AS codebase then it just isn't going to happen.

There aren't any examples in the current AS build - its provided as a separate download.

> The tooling integration I consider largely orthogonal to that and I'm happy to try to accomodate the needs of JBoss Tools if you can describe them more fully. 'importable and deployable' is a bit vague for me. I don't use JBoss Tools and have no clue what that requirement entails. Are there some guidelines on what to do (or not do) and how to test it in an automated fashion?

It's not really orthogonal (see https://issues.jboss.org/browse/TAG-16).

Making it work with JBoss Tools (or rather Eclipse, since JBoss Tools just makes it easier ;)  the simplest approach is to make it a maven project since that allows us to (and other IDE's like netbeans and intellij) to setup the proper source paths and any tooling specific stuff you have.

For TS I don't know what is needed beyond being able to build a jar with the right dependencies ?

If you have something like war or ears or other deployments in your example then let me me know what it is and I can take a look.

With respect to automation then this isn't possible to test automatically unless you want to have a full eclipse installation in your test suite and drive an SWT Bot test from it.
The "testing" is done manually when you develop your tests and verify it can be imported easily in the various IDE's and used from command line.

Again, if its a maven project simply use File > Import > Existing Maven Project, point to your example directory.
See that JBoss Tools/m2eclipse identify your maven project(s).
Verify there aren't any maven errors/warnings - and if there are; try and fix them (i.e. if you use some custom maven plugin that IDE's doesn't grok then you can add instructions to your pom to make the IDE ignore or handle it)
 On import, check the project compiles and if relevant can deploy the ear/jar/war to the relevant AS server.

Hope that gave some hints ?

/max 

> 
> Thanks
> 
> Jonathan.
> 
> On 07/26/2011 11:37 AM, Max Rydahl Andersen wrote:
>> Look at https://github.com/jbossas/quickstart
>> 
>> Has a read me with "rules"
>> 
>> notice please the:
>> "The quickstart should be importable into JBoss Tools and deployable there" :)
>> 
>> And if that part does not work - ping me or on jboss tools forum and we'll help explain
>> or see if we can make it work if some tooling limitation.
>> 
>> That rule is what makes all the quick starts (except currently osgi) directly importable into
>> JBoss tools and is what we will start relying on even more for next revision of JBoss Tools/JBDS
>> which will provide a selected set of the quick starts as "project example"/New Project wizard
>> to let users get started quickly.
>> 
>> /max
>> 
>> On Jul 26, 2011, at 12:11, Jonathan Halliday wrote:
>> 
>>> 
>>> Is there any documentation describing how to package and include demo
>>> source code and instructions in AS7?
>>> 
>>> Now that XTS is (almost) integrated I'm looking at how we can ship the
>>> demo app for it. IMO it should really be bundled with the AS rather than
>>> a separate download, but the source for it will remain in the TS rather
>>> than AS repo.
>>> 
>>> So, I need some way of packaging the source and instructions into maven,
>>> then having the AS build get them back out and unpack them into some
>>> suitable place. Ideally the AS build should then build and run the demo
>>> to ensure it works too.
>>> 
>>> I'd also be interested to know if there are particular convestions in
>>> place for how demos should build. Are they e.g. using relative paths to
>>> reference libraries in the AS dir tree, or using maven?  What is the
>>> standard format for demo README files, instructions etc? plain text, html?
>>> 
>>> Thanks
>>> 
>>> Jonathan.
>>> 
>>> --
>>> Registered Address: Red Hat UK Ltd, Amberley Place, 107-111 Peascod
>>> Street, Windsor, Berkshire, SI4 1TE, United Kingdom.
>>> Registered in England and Wales under Company Registration No. 03798903
>>> Directors: Michael Cunningham (USA), Mark Hegarty (Ireland), Matt Parson
>>> (USA), Charlie Peters (USA)
>>> _______________________________________________
>>> jboss-as7-dev mailing list
>>> jboss-as7-dev at lists.jboss.org
>>> https://lists.jboss.org/mailman/listinfo/jboss-as7-dev
>> 
>> /max
>> http://about.me/maxandersen
>> 
>> 
>> 
>> 
> 
> -- 
> Registered Address: Red Hat UK Ltd, Amberley Place, 107-111 Peascod Street, Windsor, Berkshire, SI4 1TE, United Kingdom.
> Registered in England and Wales under Company Registration No. 03798903
> Directors: Michael Cunningham (USA), Mark Hegarty (Ireland), Matt Parson (USA), Charlie Peters (USA)

/max
http://about.me/maxandersen