ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-19 04:57:58 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Cleanup of docs about building against master (#3361)

Browse Source 
* Small fixes to building-against-master docs

* Self-review

* Fixes bullet numbers.
This commit is contained in:
Joel Dudley 2018-06-13 19:51:34 +01:00 committed by GitHub
parent 18cfcb887d
commit fea296058a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/source/building-against-master.rst
View File

@ -1,30 +1,25 @@
Building against Master
=======================
Building CorDapps against Master
================================
It is advisable to develop CorDapps against the most recent Corda stable release. However you may need to build
against the unstable Master branch if you are using a very recent feature, or are testing a PR on the main codebase.
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. Open a terminal window in the folder where you cloned the Corda repository
(available `here <https://github.com/corda/corda>`_)
1. Clone the `Corda repository <https://github.com/corda/corda>`_
2. Use the following command to check out the latest master branch:
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``
3. Publish Corda to your local Maven repository using the following commands:
4. Publish Corda to your local Maven repository using the following commands:
* Unix/Mac OSX: ``./gradlew install``
* Windows: ``gradlew.bat install``
By default, the Maven local repository is found at:
* ``~/.m2/repository`` on Unix/Mac OS X
* ``%HOMEPATH%\.m2`` on Windows
This step is not necessary when using a stable releases, as the stable releases are published online
.. 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.
@ -32,5 +27,5 @@ To work against the Master branch, proceed as follows:
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.
4. Update the ``ext.corda_release_version`` property in your CorDapp's root ``build.gradle`` file to match the version
5. 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