You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by jl...@apache.org on 2017/02/15 22:23:50 UTC
svn commit: r1783156 -
/ofbiz/ofbiz-framework/trunk/tools/documentation/README.md.html
Author: jleroux
Date: Wed Feb 15 22:23:50 2017
New Revision: 1783156
URL: http://svn.apache.org/viewvc?rev=1783156&view=rev
Log:
No functional change, updates Gradle wiki page
Modified:
ofbiz/ofbiz-framework/trunk/tools/documentation/README.md.html
Modified: ofbiz/ofbiz-framework/trunk/tools/documentation/README.md.html
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/tools/documentation/README.md.html?rev=1783156&r1=1783155&r2=1783156&view=diff
==============================================================================
--- ofbiz/ofbiz-framework/trunk/tools/documentation/README.md.html (original)
+++ ofbiz/ofbiz-framework/trunk/tools/documentation/README.md.html Wed Feb 15 22:23:50 2017
@@ -245,7 +245,7 @@ under the License.
<p>Xlint prints output of all warnings detected by the compiler</p>
<p><code>gradlew -PXlint build</code></p>
<h4 id="run-owasp-tool-to-identify-dependency-vulnerabilities-cves">Run OWASP tool to identify dependency vulnerabilities (CVEs)</h4>
-<p>The below command activates a gradle plugin (OWASP) and Identifies and reports known vulnerabilities (CVEs) in OFBiz library dependencies. This command takes a long time to execute because it needs to download all plugin dependencies and the CVE identification process is also time consuming</p>
+<p>The below command activates a gradle plugin (OWASP) and Identifies and reports known vulnerabilities (CVEs) in OFBiz library dependencies. This command takes a long time to execute because it needs to download all plugin dependencies and the CVE identification process is also time consuming. But it's the only way to check OFBiz does not use vulnerable libraries.</p>
<p><code>gradlew -PenableOwasp dependencyCheck</code></p>
<h4 id="setup-eclipse-project-for-ofbiz">Setup eclipse project for OFBiz</h4>
<p>Setting up OFBiz on eclipse is easy by simply running the below command and then importing the project to eclipse. This command will generate the necessary <strong>.classpath</strong> and <strong>.project</strong> files for eclipse and it will also make the source code for external libraries available in eclipse (i.e. you can view source through Ctrl + Click)</p>
@@ -264,6 +264,9 @@ under the License.
<p><code>gradlew pullPlugin -PrepoUrl="http://www.example.com/custom-maven" -PdependencyId="org.apache.ofbiz.plugin:myplugin:0.1.0"</code></p>
<p>If you need username and password to access the custom repository:</p>
<p><code>gradlew pullPlugin -PrepoUrl="http://www.example.com/custom-maven" -PrepoUser=myuser -PrepoPassword=mypassword -PdependencyId="org.apache.ofbiz.plugin:myplugin:0.1.0"</code></p>
+<h3 id="pull-a-source-plugin">Pull a source plugin</h3>
+<p>Download a plugin from source control (currently subversion) and place it in the plugins directory. This is mostly useful when working on the trunk branch as it requires the latest version of a plugin</p>
+<p><code>gradlew pullPluginSource -PpluginId=ecommerce</code></p>
<h3 id="install-a-plugin">Install a plugin</h3>
<p>If you have a plugin called mycustomplugin and want to install it in OFBiz follow the below instructions:</p>
<ul>
@@ -272,19 +275,11 @@ under the License.
<li>Run the below command</li>
</ul>
<p><code>gradlew installPlugin -PpluginId=myplugin</code></p>
-<p>The above commands achieve the following:</p>
-<ul>
-<li>add the plugin to /plugins/component-load.xml</li>
-<li>executes the task "install" in the plugin's build.gradle file if it exists</li>
-</ul>
+<p>The above commands executes the task "install" in the plugin's build.gradle file if it exists</p>
<h3 id="uninstall-a-plugin">Uninstall a plugin</h3>
<p>If you have an existing plugin called mycustomplugin and you wish to uninstall run the below command</p>
<p><code>gradlew uninstallPlugin -PpluginId=myplugin</code></p>
-<p>The above commands achieve the following:</p>
-<ul>
-<li>executes the task "uninstall" in the plugin's build.gradle file if it exists</li>
-<li>removes the plugin from /plugins/component-load.xml</li>
-</ul>
+<p>The above command executes the task "uninstall" in the plugin's build.gradle file if it exists</p>
<h3 id="remove-a-plugin">Remove a plugin</h3>
<p>Calls <strong>uninstallPlugin</strong> on an existing plugin and then delete it from the file-system</p>
<p><code>gradlew removePlugin -PpluginId=myplugin</code></p>
@@ -298,11 +293,7 @@ under the License.
</ul>
<p><code>gradlew createPlugin -PpluginId=myplugin</code></p>
<p><code>gradlew createPlugin -PpluginId=myplugin -PpluginResourceName=MyPlugin -PwebappName=mypluginweb -PbasePermission=MYSECURITY</code></p>
-<p>The above commands achieve the following:</p>
-<ul>
-<li>create a new plugin in /plugins/myplugin</li>
-<li>add the plugin to /plugins/component-load.xml</li>
-</ul>
+<p>The above command creates a new plugin in /plugins/myplugin</p>
<h3 id="push-a-plugin-to-a-repository">Push a plugin to a repository</h3>
<p>This task publishes an OFBiz plugin into a maven package and then uploads it to a maven repository. Currently, pushing is limited to localhost maven repository (work in progress). To push a plugin the following parameters are passed:</p>
<ul>