Änderungen von Dokument Plugin-Entwicklung


Von Version 5.3
bearbeitet von awa
am 25.02.2022, 13:07
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 5.5
bearbeitet von awa
am 25.02.2022, 13:16
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -76,7 +76,7 @@
76 76  Alle Abhängigkeiten zu {{formcycle case="dat"/}} sind im scope "provided" zu definieren!
77 77  {{/info}}
78 78  
79 -Ausgangspunkt für die Entwicklung von Plugin ist das Maven-Artefakt //fc-plugin-common//. Dieses enthält die einzelnen Plugin-Schnittstellen und steht auch auf [[unserere Downloadseite zur Verfügung>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common/]].
79 +Ausgangspunkt für die Entwicklung von Plugin ist das Maven-Artefakt //fc-plugin-common//. Dieses enthält die einzelnen Plugin-Schnittstellen und steht auch auf [[unserere Downloadseite zur Verfügung>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common||target="_blank"]].
80 80  
81 81  In der //pom.xml// des Plugin-Projekts kann diese Abhängigkeit wie folgt eingebunden werden:
82 82  
... ... @@ -201,7 +201,7 @@
201 201   Auswahl eines Archetypes beim Erstellen eines Maven-Projekts in Eclipse
202 202  {{/figure}}
203 203  
204 -Für einige häufig verwendete Plugin-Typen stehen [[Maven-Archetypes>>url:https://maven.apache.org/guides/introduction/introduction-to-archetypes.html]] bereits, um schnell ein Maven-Projekt aufsetzen zu können.
204 +Für einige häufig verwendete Plugin-Typen stehen [[Maven-Archetypes>>url:https://maven.apache.org/guides/introduction/introduction-to-archetypes.html||target="_blank"]] bereits, um schnell ein Maven-Projekt aufsetzen zu können.
205 205  
206 206  Voraussetzung für die Verwendung ist, dass in den //~~/.m2/settings.xml// wie oben beschrieben das XIMA-Artifactory eingerichtet wurde. Dann kann etwa über die Kommandozeile wie folgt eine Archetype generiert werden:
207 207  
... ... @@ -219,8 +219,42 @@
219 219  
220 220  == Deploy-Plugin
221 221  
222 -TODO
222 +Um beim Entwickeln nicht jedes Mal eine neue Plugin-Version manuell über die Oberfläche hochladen zu müssen, kann das Deploy-Plugin verwendet werden. Dieses besteht aus 2 Teilen:
223 223  
224 +* Ein Maven-Plugin, welches nach dem Bauen das Plugin via HTTP an einen laufenden {{formcycle/}}-Server sendet
225 +* Ein Plugin für {{formcycle/}}, welche die Gegenstelle in {{formcycle/}} bereitstellt und das Plugin aus dem HTTP-Request in {{formcycle/}} installiert.
226 +
227 +Weitere Details können im [[Hilfe-Artikel zum Deploy-Plugin>>doc:Formcycle.PluginDocumentation.FormcycleDeployPluginPlugin]] nachgelesen werden. Für die meisten Fälle reicht folgende Konfiguration in der //pom.xml// des Plugin-Projekts aus:
228 +
229 +{{code language="xml"}}
230 + <properties>
231 + <fc-deploy-plugin-maven-plugin.version>7.0.1<fc-deploy-plugin-maven-plugin.version/>
232 + <build>
233 + <plugins>
234 + <plugin>
235 + <groupId>de.xima.fc.maven.plugin</groupId>
236 + <artifactId>fc-deploy-plugin-maven-plugin</artifactId>
237 + <version>${fc-deploy-plugin-maven-plugin.version}</version>
238 + <executions>
239 + <execution>
240 + <id>upload</id>
241 + <phase>install</phase>
242 + <goals>
243 + <goal>deploy</goal>
244 + </goals>
245 + </execution>
246 + </executions>
247 + </plugin>
248 + </plugins>
249 + </build>
250 +{{/code}}
251 +
252 +Sofern das Deploy-Plugin bereits in {{formcycle/}} installiert ist, kann das Plugin-Projekt dann beim Bauen wie folgt hochgeladen werden:
253 +
254 +{{code language="bash"}}
255 +mvn clean install -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin
256 +{{/code}}
257 +
224 224  == FC-Server-Plugin
225 225  
226 226  TODO