ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-02-21 01:42:24 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

CORDA-1046 - add docs about the split plugins to corda.net (#2712)

Browse Source 
* add docs about the split plugins to corda.net

* Update cordapp-build-systems.rst
This commit is contained in:
Stefano Franz 2018-03-06 13:02:41 +00:00 committed by Katelyn Baker
parent 1aad646243
commit 6cebd3b9a8
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/source/cordapp-build-systems.rst
View File

@ -51,7 +51,7 @@ In certain cases, you may also wish to build against the unstable Master branch.
Corda dependencies
^^^^^^^^^^^^^^^^^^
The ``cordformation`` plugin adds two new gradle configurations:
The ``cordformation`` and ``cordapp`` plugins add two new gradle configurations:
* ``cordaCompile``, which extends ``compile``
* ``cordaRuntime``, which extends ``runtime``
@ -62,8 +62,21 @@ dependency from being included twice (once in the CorDapp JAR and once in the Co
To build against Corda, you must add the following to your ``build.gradle`` file:
* ``net.corda:corda:$corda_release_version`` as a ``cordaRuntime`` dependency
* Each Corda compile dependency (eg ``net.corda:corda-core:$corda_release_version``) as a ``cordaCompile`` dependency
.. sourcecode:: groovy
dependencies
{
classpath "net.corda.plugins:cordapp:$corda_gradle_plugins_version"
classpath "net.corda.plugins:cordformation:$corda_gradle_plugins_version"
}
apply plugin: 'net.corda.plugins.cordapp'
apply plugin: 'net.corda.plugins.cordformation'
The Cordapp plugin should be applied to any project that will be building a cordapp, and the cordformation plugin should be applied to projects that wish to create small testing networks locally.
After doing this, ensure that:
``net.corda:corda:$corda_release_version`` is defined as a cordaRuntime dependency and
all other net.corda compile dependencies (eg net.corda:corda-core:$corda_release_version) are set as a cordaCompile dependency
You may also want to add: