Changes for page Flavor API

Last modified by Admin on 2024/04/18 01:17

From version 27.67
edited by Admin
on 2019/11/25 15:49
Change comment: Imported extension [org.xwiki.platform:xwiki-platform-flavor-api] from repository [maven-xwiki:maven:http://nexus.xwiki.org/nexus/content/groups/public]
To version 28.1
edited by Vincent Massol
on 2019/11/28 16:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.Admin
1 +xwiki:XWiki.VincentMassol
ExtensionCode.ExtensionClass[0]
Description
... ... @@ -29,7 +29,6 @@
29 29   </properties>
30 30  {{/code}}
31 31  
32 -
33 33  === Known invalid flavors
34 34  
35 35  Since 9.5 it's possible for a distribution to indicate known invalid flavors, which means flavors id known to be invalid with this distribution (a good example is XWiki Enterprise which are invalid in 9.5+).
... ... @@ -126,3 +126,21 @@
126 126   </build>
127 127  </project>
128 128  {{/code}}
128 +
129 +=== Testing ===
130 +
131 +To test a flavor you're developing follow these steps:
132 +* Build the flavor: ##mvn clean install##
133 +* Edit the ##META-INF/extension.xed## file inside the XWiki WAR you're testing with and add your flavor id and version to the list
134 + of known flavors. Note that this is a hack since normally the canonical way would be to deploy the flavor in a
135 + searchable XWiki Extensions Repository but that's a lot more complex and time-consuming.
136 + * Modify the `<xwiki.extension.knownFlavors>` tag to add the flavor id and version. For example if you wish to test the ##org.xwiki.contrib:flavor-demo/1.1-SNAPSHOT## flavor:(((
137 +{{code language='xml'}}
138 + <xwiki.extension.knownFlavors>
139 + org.xwiki.platform:xwiki-platform-distribution-flavor-mainwiki/11.10,
140 + org.xwiki.platform:xwiki-platform-distribution-flavor-wiki/11.10,
141 + org.xwiki.contrib:flavor-demo/1.1-SNAPSHOT</xwiki.extension.knownFlavors>
142 +{{/code}}
143 +* Add your local Maven repository as an Extension repository in the XWiki instance.
144 +* Start or restart XWiki.
145 +

Get Connected