corda/docs/source/building-against-master.rst
Joel Dudley fea296058a
Cleanup of docs about building against master (#3361)
* Small fixes to building-against-master docs

* Self-review

* Fixes bullet numbers.
2018-06-13 19:51:34 +01:00

1.5 KiB

Building CorDapps against Master

It is advisable to develop CorDapps against the most recent Corda stable release. However, you may need to build a CorDapp against the unstable Master branch if your CorDapp uses a very recent feature, or you are using the CorDapp to test a PR on the main codebase.

To work against the Master branch, proceed as follows:

  1. Clone the Corda repository

  2. Open a terminal window in the folder where you cloned the Corda repository

  3. Use the following command to check out the latest master branch:

    git checkout master; git pull

  4. Publish Corda to your local Maven repository using the following commands:

  • Unix/Mac OSX: ./gradlew install
  • Windows: gradlew.bat install

Warning

If you do modify your local Corda repository after having published it to Maven local, then you must re-publish it to Maven local for the local installation to reflect the changes you have made.

Warning

As the Corda repository evolves on a daily basis, two clones of the Master branch at different points in time may differ. If you are using a Master release and need help debugging an error, then please let us know the commit you are working from. This will help us ascertain the issue.

  1. Update the ext.corda_release_version property in your CorDapp's root build.gradle file to match the version here: https://github.com/corda/corda/blob/master/build.gradle#L7