From e08408080455b6d14205e674a3f64c16f3ef54a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cristiano=20Gavi=C3=A3o?= Date: Tue, 23 Oct 2018 11:40:06 -0300 Subject: [PATCH] 2: Setup maven-site Task-Url: https://github.com/cvgaviao/osgi-subsystem-maven-plugin/issues/2 --- ...le.gen.subsystem.composite.no.embedding.md | 1 + ...example.gen.subsystem.feature.embedding.md | 1 + src/site/markdown/index.md.vm | 43 +++++++++++ src/site/markdown/usage.md.vm | 44 +++++++++++ src/site/resources/images/c8tech.logo.png | Bin 0 -> 8762 bytes src/site/site.xml | 69 ++++++++++++++++++ 6 files changed, 158 insertions(+) create mode 100644 src/site/markdown/examples/example.gen.subsystem.composite.no.embedding.md create mode 100644 src/site/markdown/examples/example.gen.subsystem.feature.embedding.md create mode 100644 src/site/markdown/index.md.vm create mode 100644 src/site/markdown/usage.md.vm create mode 100644 src/site/resources/images/c8tech.logo.png create mode 100644 src/site/site.xml diff --git a/src/site/markdown/examples/example.gen.subsystem.composite.no.embedding.md b/src/site/markdown/examples/example.gen.subsystem.composite.no.embedding.md new file mode 100644 index 0000000..f3b491e --- /dev/null +++ b/src/site/markdown/examples/example.gen.subsystem.composite.no.embedding.md @@ -0,0 +1 @@ +Example of how setup in order to generate a Eclipse P2 and a Target Platform file. \ No newline at end of file diff --git a/src/site/markdown/examples/example.gen.subsystem.feature.embedding.md b/src/site/markdown/examples/example.gen.subsystem.feature.embedding.md new file mode 100644 index 0000000..f3b491e --- /dev/null +++ b/src/site/markdown/examples/example.gen.subsystem.feature.embedding.md @@ -0,0 +1 @@ +Example of how setup in order to generate a Eclipse P2 and a Target Platform file. \ No newline at end of file diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm new file mode 100644 index 0000000..28964a7 --- /dev/null +++ b/src/site/markdown/index.md.vm @@ -0,0 +1,43 @@ +Introduction +-------------- + +The OSGi Repository Generator maven plugin is aimed to manage the lifecycle of a project that can generate both P2 or OSGi R5 indexed files based on bundle hosted in P2 or maven repositories. +This plugin provides a 'osgi-repository' packaging that should be used in order to be able to manage is lifecycle. + + +### Main features: + +* download and locally cache bundle or subsystem artifacts from maven or p2 external repositories. The artifacts to be downloaded can be from the declared dependencies as can be described in the plug-in's configuration tag. +* generate P2 or compressed repository index artifact (.zip) using the cached bundles or subsystem artifacts. +* generate a local maven repository artifacts using the cached bundles or subsystem artifacts. +* generate a R5 OSGi index XML file or as compressed artifact (.zip) using the cached bundles or subsystem artifacts. + + +Quickstart +---------- + +The plugin provides the `osgi.repository` *packaging type* + + my-project + my-osgi-repository + osgi.repository + + +Add the following to your plugins section: + + + ${project.groupId} + ${project.artifactId} + ${project.version} + + +And then use the *osgi.repository* as the packaging type of your repository project. + +See [usage](usage.html) for more details. + + + +Prerequisites +------------- + +The plugin requires **Maven ${project.prerequisites.maven}** or later and **Java 8** or later. \ No newline at end of file diff --git a/src/site/markdown/usage.md.vm b/src/site/markdown/usage.md.vm new file mode 100644 index 0000000..ee9fc1d --- /dev/null +++ b/src/site/markdown/usage.md.vm @@ -0,0 +1,44 @@ +The OSGi Subsystem Archive Generator Maven Plugin +------------------------------------------------------ + +This plugin was designed to generate an OSGi Subsystem `.esa` archive containing a manifest file and contents based on the dependencies defined in the project POM file. + + +Each type will instruct the plugin to generate the subsystem manifest accordingly. + +The plugin can embed the declared dependencies into the generated archive. + + +The artifact generated by this plugin can be used by the [Repository Plugin](../osgi-repository-maven-plugin/index.html). + +Quickstart +---------- +The plugin provides three `packaging types` that the developer must be chosen: + +* subsystem-application +* subsystem-composite +* subsystem-feature + +``` + my-project + my-osgi-repository + osgi.repository +``` + + +Add the following to your plugins section: + + + ${this.groupId} + ${this.artifactId} + ${this.version} + true + + +Release your project by running `mvn releaser:release` + + +Prerequisites +------------- + +The plugin requires **Maven ${project.prerequisites.maven}** or later and **Java 8** or later. \ No newline at end of file diff --git a/src/site/resources/images/c8tech.logo.png b/src/site/resources/images/c8tech.logo.png new file mode 100644 index 0000000000000000000000000000000000000000..1f11bc089a39e4bd3719a9a614999179ef06a46a GIT binary patch literal 8762 zcmV-ABE{W_P)FM00004b3#c}2nYxW zd&U%(TXJ*zjXYu+ttY;l(%sA}YUQ7-K6ATDRNGPBjJE}u< zto-8s@!qR?Rb5qG-Rf?6e7Jq?dB1w8Ufu7z_x^tOcYn9xJ$jGcqxa}NdXL_t_vk%( zkN(Y&aK0a)2+hVbS+j7Dd8K&;;#)s?_2x+9qRZ1d=q6+|Q&4qC>o74ku1q8*WL<}h z4!QxV35IjrFhCRhrVwn-sHVM7)pN%)s-a~xBdO`2nu3+lu@9OWm?oeD8kjm5&NkNh zHgDYbhUXEjg6+JKJYQdQ<<_miw)QpOsERaqWOPVtw!kwwWHbmhLA}#<_ZOa%cG{LB zN6V3^pgXKN`*duiP0eA|)Aq3BKSbl|D~KM=U<=;@Oy`m36%28{zUUKMzxe6uy5#zxDz;KJ^(O2>1a7`{fjwXKOJp zKwPfhxeqc>rTxfVk(* zFMehw+Avd%sYn~#{r*TBEC1rNKrJ>HL2S*C_(KBX%B@?2&28=XPck1Byy-L1m}zN) zyT9SWPf)#hB{mpgAiz9p#he3i&s`6G*42hQArL@6iQBhcQ(?_s1 zB81(8^7@K717l8rm&!zULL{@3aNH4#ZbX=+NPS@pN#|Q_$0v8u`CVrlxi8eg{ff~Y0y&kepAOX z4bYQ<``NZlre({?DB7M=A>#7R|S$PS;owOkp`p4Hb->`wKoF41veCoffHn$T_3UTzOYc+{(vk3f>fSG z2?Wve+0zz8=Xl}yp5vw3=Su0plf=#(!gkUDhkd?a^(~3CK{9QTR3V{4G6ROL6#>D+ zUJ|9PKr{BhF^Ff3GOIw;Z@lNTN~m$EB!VailZ9KfJr$R@PAs^G7pR$%Wmt?IeHB|S zGPaZUH7;Bd(gfe;gldtsx&;B@C}cQ`(on>iPW%w78B57WLb@Y9=A=iO9B=M7LgTK zGJawQb_XDZW1?ma2<5W7?h~r&mYO<9qRpZyV2YC6D=8+hqU|z*E(@HQ58QOYFm;3R zL$5)0g2;8KW{-Hu4aeU0Z9-2#I_fy$vykkAL|^gm5)_b?$@{BXuVMVeVPM?h6rj(F zX=?evgCT!I$2J!LSAKb|(8T(hCJJodDb)UbgZfPM1vg<3RYyZm$eL7CQQZiJPvBSS3 zrv*BW=~#5l11kc-P?M|#K@R1E;PP}x@+~B^XbE<2%$@rX&)GCJUj51HP+j}|h6ex_ z1b3flO~a&QP0%cuvr5fVtaB$?d;}W^9Z<1NMsmRgTds@+0|YFEct#pPFhwvVEZqW2 zK#+W3Nm!=mhL(5)D5se+7=J_~>xY{y^ULe4y$8xX6mzVE(3b;FWU!Y}SCDs;MKfvdpDSK_#}*a%}s zc93t9(%4~*__}NExHc5@Q{`7kcD-JOsDLQxj2=Da0G9&BfC1nv(Ccttww>&Jo~*`* zx&w+pb;m|LPJ70tY5DsfibR^)A27u-CaGYb+51|Q;k`PR1(uVTlx>>;7NXC{2H*@8 z45Jq`3rmmy1ld6*hvA%K>cxLVYVaVYo^pihnxq5}2NDb0 zmTno=d{n7IEIxR2C87fA_!0C(+5s*G3<0AKD6Uh=1qKuSotXL&M0qWeuho7aK_=L+ z0eA){!aHLiR&CmPZy;RXmeD5*-wQ%^pOG-MV?PdH>fwsNB!1={`rmjO@)ExaBYWpU zu6@_Z`Gq(TzxgBEsw36a8`4RIOn1+53*iz(8B&7>oNF@JKn!Dpk#Oz<BLn1|sOGRrE^1i{j7lePTupPktK+}~kf^P#F;$;TFe9j^jvZc!s1Wj* zeXZ>agyV+?yiVGkuh7V8ZT_7{TS}3eG_p#ti4wjQi!J~}sTM;$3zp8ri6hwK zi0PZA)tBD6tt!&cs_KqOvWoZvk5-6ALQizP6|q&jLK;84m(;MU4epPQJ3>le+jDou ztQ?io46m@VBWavB{I5QHYuB^;)V=TQ-*33j{?XgE)Q2VYLf~cWmqYbDM`=@ONw*?c zHMt$e1e!XIo=~wv;mWjtxOD47k@}XU+a#~~F-w~yS%l$ZPYxPVu(hHuumDTd8QS%x zv&Y+;aqaO0xu|6^0ZeCJ*}c|{EvX*11S|8@?{>Uc6VClpczn=*{nn$8kH#_$hze~jHKPEc zBr8|n{<(G7F`}sx&@AOcWOJj;UI0X;iP)(F$(bK^8ak4{9YF?D?Ib-sLC)-^D>hB*ufOyD>RQ`3l=25& zGo|Wrec;r=2x6$xuYi$5`$!H9k*^J|a9se>$m(TAReQ3q%1(qBPMVdO4u~@R*&ZSkIL6;%uDR|0NNvNyN`iZ`2xtkttMg1`>h7wC#}4l!aW+bR zm(>Nq?I{(GA?A8{l|}cjUq_Hf5Eb^E7>j5IXa>}`Z%W&9(`nG1t-~o5QW~7v^Gwcn z_^Os5DqvYd#Ll=qLN~TGH4s}r{nf~V#U1yS6Mo^bo&(PhW`x=b#tp7-uylG}EE$Ss za+244kwxEb6@=#zWztqv>xs^RaaD(^#g{jDh3^F;r9vuWnDNoGD*+J2UZh|%q5_%G zcb$8?VU-k+nbI_Exb_2|tFEqTEj!=f`D|$k{nVM>2x8?SC5GPKN3w5-+_<3GVA7)dp8x&$l+@D7xbX z+HOuE2*EwaqrUcy_R?aO-qOL)9*FLS(Sv!HsNN60`dUN+ z#MXvN!WfbWW+tW|Iz3dxHJ}_odT%jjTnd;I@4PgalAA-51zyTG zm^z(LZs+$|8*DN`f71RfvV8c^fj-s1N%3^nY?mTm^)RAOKvE!f%8lH*y(KqRWt0Ts z`VZW>EmBv%u$TrE+h?XHv^}TBr`J;&+_jf@*YC47xMVTb^CW^|AS!hA3|X2^P8%!@ zEUWmqCb+=T#kyIgV`GXnDAJl|Ez>urMx>OZ3#bCf62nKxqKmg#z zE0$-F6p#W63$Iy04u}k%2ti38cJJP;cb`1;&8bY1B*LDZuM8&SC6$jG3{7YJLDj0CaFPEvxV;k#Y;7j+M1PZRl|r1R4=;#QE_FS_q)oDBlhp# zuXY|g@J}1AYW<(3e8sNqzZ;xTmQBMq#5Kka)*=P$lo-(`)AYXU=z7j|WM1K)e-Hp_ ztQ)ZuJGU}5k-%3AMw-Nl*Iyd+jc1H1Q=AA}LVpNOhM=(;TAEvGF1>2Yl>j%suWkJJ zlidvnQkd53I_PjHhqb3}dA1)@ z?01gfF{8m?NP22#bb~Jt2wr>1iqN;7?zdBinl^2q=f$_lEs~U|BpbZ9w>N$K(Az&K zHUaeJ8`}rt{^eDr%}}9l$Y>1jt(%kpCIuCmuKJ+!U_OVvlP>44(%M!_LiF8Y=QK^6 z#LyOCq+xjP0ejsZ2DV?Dz|L=q0?|||G0@j@Y9Byr>%!*d+Q0;o0+E#)u;(z`b=(r= z)8MjZ!T8$WfBwfKLp`0|2_Q8wu0D6Px_(+crQR2Z5S3ujWm%DxR}gGjf@irD^RTRT zN)nD=ji@vt$}o0xC>!AGe(qgIK525mOcub60;Xup(%8%_?9ssWJHWWNmQUa?nTX=3BAf6nC+C zo*kV{`BqF);5NIrq(Gvx$p#{xs|vC}MFAUc7rCw}(b|A%F%09!6!CTA_h z!Y!9z|2{VxT$&09cf_lI{U84FhZ7_HXJipFiHXb;N9!A=r43!r4?DxG`_pnXZ} zqEJvtBl@8Jf{V$mTJ=+560!y8(eCc};eFeGB#H3KTL(JFl~t9G8}yV$|Mt?_kkyKi zkJcM*VR8wE^P&|O{gSz0#7EEj0(D}p=qEucR+>Gw}b$>*7 z(K63NdMD@S6^O6i*?4;-tk`3Ky7i7(O6qh!cbHtvs91G^Y?|n)L;HX2$k006FWBMm z%+NT&X4gCg0e_`HSb#p#*Ejy~cVGSan15vrl8=gca9367^$rEBRQp(T}E=@4lmC&UP!3K&31#*^(^2zM()H+;+ppYYDe5Ay+qP-hIUzC#+`O zV$)TtWIv*8Yj&_X%EU=`s?!^i$xuA2!~%>=D*5yqN5_V;UHW8q5GA|@v8o39MGH&^ z2s?6^>YY%cyMN@D?bQ{PaB$@v&4MTbJ+ z8$*olJ47xY$r~ju6__-mqXUmWwky+Y`^#7i%US?}Lf!I8P8x5Wm z$}Vv$>*L=XNE{m!mmw-}_VsS(Hvm4@2L`7Lgsl~$2giu+{^4}AqI%68Es`iCDq6NB zNZ_ju(7yFniua%jLm=nMlPD33J#Ls-h6xw8>S9whG*t^?)8+TBCpXpUa=9q6Mb*;V zvK^PPgLYWSvJA$LyV>B=ULTQ7cS*hcrSFFpZ~CNE)znt(q)8-)0UcQ}5ETniF%jf(BsZL**w;%wuq+8Zqh#&7@`erV{J|KipH?1iGrwv*8TDNvrlI$%v6?f zCsxBPXb7dNiEttHmGFQE%! zsH`@)ZGT;m<|`JE=v$r>wj*%Ko0#DA&b;xhJa9@JUn}=B@WLbHW(o7^D5aC>Ck(S{ zBZ3rc_6?mD0!{5gc;%XR>skY;(Y~@8m8H95%}B;3EE5K{9|2(_0IA^vp6h2+S10Q$ zhF|&O55)99U&SV>s#Z{Ch6RQRAz9Bfg`v4dRyKU_bL+_kD9dMqEAs7#ioNu!|IM7{#ZI}g zDw7%3;>h}n^uWvaYD#TzIoKE^vbujtp_>KAO9JOPUk=sM ze&?64t6I8?&t2j2Hjwo#%>jpc!``RjAH{E*O0*-ty zjUWXOL`RsCN3f;ZVv%;ixwUJz(*EJ+IQ`g8a@|okd|{@O$)^lzzJTbfNyVc*OIsTk z)m^Y|y>R_Mf7}wpIHEL;rJu#r;%Es4Eh(bLYtUlIXz4|b(&m8)iB#tsM?qK*KxX(| z$Yz75IfoJu9<4YKO%LpOG*oxfUsZbL;)_1me75`BDOCstD;jYJnu0`Dogvn_EKiW8 zNVevNCE9Pf;1Rkhd5%kyk6Q+aip=tleu2}E-A``D((R%e!y|o<%e6IMFf8basMYsfq#0!b+a-C$*iezt%^x>ny3^ntb6F2t6z8630umtCzJi`1%e~ z(Qz*ry}O?2S#te-f1cFDa5Pihu)D9O?(MU+^{TJA0e^i1{zwB#btArTBXXz_InbEV zg$0L?ooPIL^jKpunWzIn!ZMQ#y!9kl8g|FPUEdu$7t`cYcC@|!vA_AQnI4LIyQ^ix z9yPVTb;}z@iuas~`3?!%KU#;SYvp~w6sD+@Ia9(_tbO3)9D-{qK^W4emy6 zOJ{@601Ok*cKqTi|74_cT2X3X=W?XB-gn9J&~QcC;I=#Nti{swNk3dmKxP;+QM(#t zdI(ZOkQ#JKMZ0CA`yg@Fu27liv02a9_Yg#pmG|6DfmXcw{rA76X_@1OX`~I4B8B0n z&J6-m$d6h#d96h-lBo6~CxR)q-oeR<&fB=AcXmO7R_*Q=$HsjA(_1HSLP zDAj=B3MJH+1CdZf0B%2A6FQnitx}+Mid-UtT@vtD z*JaQ1ZWTdS-hT04p8>;08%PyTD{?Jk1pl`q8(a>mNG3=cg+-Zoa?Li?6%(n#MPN@@^(2E%FziQk4(|VP=9a zQY)nJy4Rli-kWE;4iA$Ptmt8ZoR+w2{k&1vN`UaLj&j$3SWwEgof~Dp?1i8H{de@_ z$Y`Zu^7_Um|Mkn`(Q@6`LV?egHVk$h8h-lGzjc=xyT8Hku$!yot%?xGHaD)>nTlOA zTmzw>c;}_wfz$hbHl4Zc8?M{b5YUITQrb{Xs51pc5-eW+#Un4N>7<*D;f|`k zORNf$$K3P0i)$+3qJ_5R0thb{+DkwEyKn2sk+Gr!J83dEHZ=!6&@nt%i8fRWiclVu zBfFkC{`%8DbO&1o`O9zJrDTPLx=NLftCaI-u7S|s+3`|u-|2lnD<gtbM);#^6h_${KR5+AU0pQR{16MK0+*emo&MJHt8bj))l4s$gCEyN2NaO&~iP{i2a|Z+<)X+@&lQm{dA z!w*B`LJ)2|XigX2&$UK?M=QvG>)h}F6i?Kelm^M{1L1a8-8$dyz{~9^m8vZ}>ogxg zKyhcNKsL8$Dj?kLYyy!@A0?M!KaOpdlH`XV{@{RcrwH8`jp=+YTvJ^P1Sk%|Ou+C8 z*PGVj`i6Pc2ADq}V6r`iTzuXIrW6ofDvWf_6bN_gYHH!End_kcAc1hT!WFhk`3eK2 zfGGEQI?n_7VGVCobl$W9=BL+GNTS1%!|vzVe3oMOD!HPE{2-p&o;PiP^8*AFU+ptp knvG{K?3on?_2!NKKRUL^z5w$BLjV8(07*qoM6N<$f(r}%+yDRo literal 0 HcmV?d00001 diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 0000000..aedd134 --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,69 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.7 + + + + + false + true + + + cvgaviao/osgi-subsystem-maven-plugin + + right + black + + + + + + ${this.organization.name} + images/c8tech.logo.png + ${this.organization.url} + + + ${this.name} + ${this.url} + + + + + + + + + + + + + + + + + + + + + + + + + + + +