Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[mdt-ocl.dev] Fwd: Re: MWE Releng: Some questions

Hi all,

Forwarding some information concerning how I managed to include the javadoc into our build process (If any third eye is interested in it ;P)

I think I forgot to include the bugzilla reference: https://bugs.eclipse.org/bugs/show_bug.cgi?id=337202

Please, have a look to my last comment, since I need some feedback to make progress on this.

Best Regards,
Adolfo.

-------- Mensaje original --------

Thanks for your hints!
You are free to publish this information wherever you want ;)
I think about a wiki page, something like , "Modeling releng how to" or better "Modeling releng best practice" :)

Dennis Hübner

Softwarearchitekt

Tel.:    0431 5606 336
Fax.:    0431 5606 339
Mobil:   0151 173 96 707


http://www.itemis.de/

itemis AG
Schauenburger Str. 116
24118 Kiel

Rechtlicher Hinweis:
Amtsgericht Dortmund, HRB 20621
Vorstand: Wolfgang Neuhaus, Jens Wagener, Dr. Georg Pietrek
Aufsichtsrat: Prof. Dr. Burkhard Igel (Vors.), Stephan Grollmann, Michael Neuhaus

----- Ursprüngliche Mail -----
Von: "Adolfo Sánchez-Barbudo Herrera"<adolfosbh@xxxxxxxxxxxxxxxx>
An: "Dennis Hübner"<dennis.huebner@xxxxxxxxx>
Gesendet: Freitag, 18. Februar 2011 13:45:14 GMT +01:00 Amsterdam/Berlin/Bern/Rom/Stockholm/Wien
Betreff: Re: MWE Releng: Some questions

Dennis,

I've completed the javadoc publishing, including the zippping/unzupping process. You may note that publishing the javadoc is not really working for you by the moment. The changes I've made which may be similarly adopted by you, are the following:

**** Changes javadoc.ant file ****
- Add the following ant task at the end of the "create.javadoc" target:
<!-- Compress the output javadoc in a zip file -->
<zip destfile="${output}/${projectName}-javadoc.zip" basedir="${output}"></zip>

**** Changes promoter.ant file ****
- Replace the "copy javadoc" ant task of the "publsh" target by the following one:
<echo>Unzipping javadoc</echo>
<unzip dest="${project.javadoc.directory}">
<fileset dir="${javadoc.directory}">
<filename name="*-javadoc.zip" />
</fileset>
</unzip>

NB: I use slightly different javadoc publishing mechanism, since I want to use a common (one place in the project) javadoc directory (that's my project.javadoc.directory property).
NB2: It looks like your task in your folder is not correct, since you are using "testresults.directory" rather than "javadoc.directory"

**** Changes to job's configuration ****
- In the first "run command shell" section (prior to buckminster commands):

Include in a new property added by hudson in the ocl-buid.properties file: javadoc.base=MDT-OCL.javadoc

NB: You must configure this property in the "publisher.properties" file for your releng project.

- In the "run command shell" section (after buckminster commands) I added the following:

mkdir MDT-OCL.javadoc
mv buildroot/buckminster.output/org.eclipse.ocl.releng.buckminster_*-buckminster/javadoc/MDT-OCL-javadoc.zip MDT-OCL.javadoc/MDT-OCL-javadoc.zip
rm -rf buildroot/buckminster.output/org.eclipse.ocl.releng.buckminster_*-buckminster/javadoc

NB: Note that I use "buckminster.output" folder while you yse "buckminster.build" folder.
NB: The last command let us save some space in the job's workspace.
NB2:The MDT-OCL.javadoc should be removed every time the job is run. If you similarly use "xtext.javadoc" name, this will already be done every time you rune with your first command: "rm -rf buildroot xtext.*". You only need to remove the current "javadoc" folder deletion.
NB3: Similarly "xtext.javadoc" folder would now be included in the result artifacts of the job. It is not currently included.

BTW !!!

If you use the following "tag" nested elements in the javadoc ant task you will avoid some stupid warnings:

<tag name="generated" description="Generated"></tag>
<tag name="model" description="Model"></tag>
<tag name="ordered" description="Ordered"></tag>

If you don't mind I'll publish the information about how we are dealing with the javadoc in our mdt-ocl.dev newsgroup and/or related bugzilla... Please, let me know if you have any kind of inconvenience.

Cheers,
Adolfo.

El 16/02/2011 15:56, Dennis Hübner escribió:

I think the solution described in http://dev.eclipse.org/mhonarc/lists/mdt-ocl.dev/msg00751.html is a best one.
About zipping: Javadoc is added to the archived build artifacts, so to save hard drive space, it's better to zip javadoc during the build and uzip it when promoting.

Am 16.02.11 16:31, schrieb Adolfo Sánchez-Barbudo Herrera:

Dennis,

I'm not sure which is your intention when zipping the javadoc. Are you trying to include the javadoc in any kind of documentation plugin ?

You could read what I want to do with the javadoc in the following mdt-ocl.dev threads

http://dev.eclipse.org/mhonarc/lists/mdt-ocl.dev/msg00749.html

http://dev.eclipse.org/mhonarc/lists/mdt-ocl.dev/msg00751.html

Cheers,
Adolfo.

El 16/02/2011 15:20, Dennis Hübner escribió:

Zipping javadoc would be nice, so maybe you can add this to the javadoc.ant script, and than share with me!? ;)

Am 16.02.11 16:18, schrieb Adolfo Sánchez-Barbudo Herrera:

Yes !!

I looked at it yesterday. I'll probably copy-paste your stuff and tune up the necessary bits for my project ...

Cheers,
Adolfo.

El 16/02/2011 15:11, Dennis Hübner escribió:

I already added javadoc generation part in Xtext, maybe you can reuse something.?

--


	Open Canarias, S.L.
	Adolfo Sánchez-Barbudo Herrera
adolfosbh(at)opencanarias(dot)com
C/Elías Ramos González, 4, ofc. 304
38001 SANTA CRUZ DE TENERIFE
Tel.: +34 922 240231

--
Dennis Hübner

Softwareentwickler

Tel.:    0431 5606 336
Fax.:    0431 5606 339
Mobil:   0151 173 96 707 http://www.itemis.de/ itemis AG
Schauenburger Str. 116
24118 Kiel

Rechtlicher Hinweis:
Amtsgericht Dortmund, HRB 20621
Vorstand: Wolfgang Neuhaus, Jens Wagener, Dr. Georg Pietrek
Aufsichtsrat: Prof. Dr. Burkhard Igel (Vors.), Stephan Grollmann, Michael Neuhaus

--


	Open Canarias, S.L.
	Adolfo Sánchez-Barbudo Herrera
adolfosbh(at)opencanarias(dot)com
C/Elías Ramos González, 4, ofc. 304
38001 SANTA CRUZ DE TENERIFE
Tel.: +34 922 240231

--
Dennis Hübner

Softwareentwickler

Tel.:    0431 5606 336
Fax.:    0431 5606 339
Mobil:   0151 173 96 707 http://www.itemis.de/ itemis AG
Schauenburger Str. 116
24118 Kiel

Rechtlicher Hinweis:
Amtsgericht Dortmund, HRB 20621
Vorstand: Wolfgang Neuhaus, Jens Wagener, Dr. Georg Pietrek
Aufsichtsrat: Prof. Dr. Burkhard Igel (Vors.), Stephan Grollmann, Michael Neuhaus

--


	Open Canarias, S.L.
	Adolfo Sánchez-Barbudo Herrera
adolfosbh(at)opencanarias(dot)com
C/Elías Ramos González, 4, ofc. 304
38001 SANTA CRUZ DE TENERIFE
Tel.: +34 922 240231



Back to the top