mirror of
https://github.com/corda/corda.git
synced 2024-12-23 06:42:33 +00:00
384 lines
17 KiB
HTML
384 lines
17 KiB
HTML
|
<!-- If you edit this, then please make the same changes to layout_for_doc_website.html, as that is used for the web
|
||
|
|
doc site generation which we put analytics tracking on to identify any potential problem pages -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!DOCTYPE html>
|
||
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
|
|
||
|
|
<title>Publishing Corda — R3 Corda latest documentation</title>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||
|
|
<link rel="next" title="Working with the Corda Demo on Azure Marketplace" href="azure-vm.html"/>
|
||
|
|
<link rel="prev" title="Building the documentation" href="building-the-docs.html"/>
|
||
|
|
|
||
|
|
|
||
|
|
<script src="_static/js/modernizr.min.js"></script>
|
||
|
|
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body class="wy-body-for-nav" role="document">
|
||
|
|
|
||
|
|
<div class="wy-grid-for-nav">
|
||
|
|
|
||
|
|
|
||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
|
|
<div class="wy-side-scroll">
|
||
|
|
<div class="wy-side-nav-search">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a href="index.html" class="icon icon-home"> R3 Corda
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="version">
|
||
|
|
latest
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div role="search">
|
||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<a href="api/index.html">API reference</a>
|
||
|
|
<br>
|
||
|
|
<a href="https://discourse.corda.net">Discourse Forums</a>
|
||
|
|
<br>
|
||
|
|
<a href="http://slack.corda.net">Slack</a>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<p class="caption"><span class="caption-text">Getting started</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="inthebox.html">What’s included?</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="getting-set-up.html">Getting set up</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="getting-set-up-fault-finding.html">Getting set up: troubleshooting</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="running-the-demos.html">Running the demos</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="CLI-vs-IDE.html">CLI vs IDE</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption"><span class="caption-text">Key concepts</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="data-model.html">Data model</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="transaction-data-types.html">Data types</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="merkle-trees.html">Transaction tear-offs</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="consensus.html">Consensus model</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="clauses.html">Clauses key concepts</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption"><span class="caption-text">CorDapps</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="creating-a-cordapp.html">CorDapps Background</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="creating-a-cordapp.html#gradle-plugins-for-cordapps">Gradle plugins for CorDapps</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-cordapp.html">The CorDapp Template</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-cordapp.html#building-the-cordapp-template">Building the CorDapp template</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-cordapp.html#running-the-cordapp-template">Running the CorDapp template</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-cordapp.html#interacting-with-the-cordapp-template">Interacting with the CorDapp template</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-cordapp.html#extending-the-cordapp-template">Extending the CorDapp template</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption"><span class="caption-text">The Corda node</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="clientrpc.html">Client RPC</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="messaging.html">Networking and messaging</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="persistence.html">Persistence</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="corda-configuration-file.html">Node configuration</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="corda-plugins.html">The Corda plugin framework</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="node-services.html">Brief introduction to the node services</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="node-explorer.html">Node Explorer</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="permissioning.html">Network permissioning</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-contract.html">Writing a contract</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-contract-clauses.html">Writing a contract using clauses</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-test-dsl.html">Writing a contract test</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-integration-testing.html">Integration Test Tutorial</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-clientrpc-api.html">Client RPC API tutorial</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-building-transactions.html">Building Transactions</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="flow-state-machines.html">Writing flows</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="flow-testing.html">Writing flow tests</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="running-a-notary.html">Running a notary service</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="using-a-notary.html">Using a notary service</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="oracles.html">Writing oracle services</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="oracles.html#implementing-an-oracle-with-continuously-varying-data">Implementing an oracle with continuously varying data</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="oracles.html#using-an-oracle">Using an oracle</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorial-attachments.html">Using attachments</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="event-scheduling.html">Event scheduling</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption"><span class="caption-text">Other</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="network-simulator.html">Network Simulator</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="initial-margin-agreement.html">Initial margin agreements</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption"><span class="caption-text">Component library</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="contract-catalogue.html">Contract catalogue</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="contract-irs.html">Interest rate swaps</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption"><span class="caption-text">Appendix</span></p>
|
||
|
|
<ul class="current">
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="loadtesting.html">Load testing</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="setting-up-a-corda-network.html">Introduction - What is a corda network?</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="setting-up-a-corda-network.html#setting-up-your-own-network">Setting up your own network</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="secure-coding-guidelines.html">Secure coding guidelines</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="release-process.html">Release process</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="release-process.html#steps-to-cut-a-release">Steps to cut a release</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release notes</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="codestyle.html">Code style guide</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="building-the-docs.html">Building the documentation</a></li>
|
||
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Publishing Corda</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#before-publishing">Before Publishing</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#publishing-locally">Publishing Locally</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#publishing-to-jcenter">Publishing to Jcenter</a><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="#getting-setup">Getting Setup</a></li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="#publishing">Publishing</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#publishing-to-maven-central">Publishing to Maven Central</a><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="#id1">Publishing</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="azure-vm.html">Working with the Corda Demo on Azure Marketplace</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption"><span class="caption-text">Glossary</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
|
|
||
|
|
|
||
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
|
|
<a href="index.html">R3 Corda</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="wy-nav-content">
|
||
|
|
<div class="rst-content">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
|
<ul class="wy-breadcrumbs">
|
||
|
|
<li><a href="index.html">Docs</a> »</li>
|
||
|
|
|
||
|
|
<li>Publishing Corda</li>
|
||
|
|
<li class="wy-breadcrumbs-aside">
|
||
|
|
|
||
|
|
|
||
|
|
<a href="_sources/publishing-corda.txt" rel="nofollow"> View page source</a>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<hr/>
|
||
|
|
</div>
|
||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
|
|
<div itemprop="articleBody">
|
||
|
|
|
||
|
|
<div class="section" id="publishing-corda">
|
||
|
|
<h1>Publishing Corda<a class="headerlink" href="#publishing-corda" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="section" id="before-publishing">
|
||
|
|
<h2>Before Publishing<a class="headerlink" href="#before-publishing" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Before publishing you must make sure the version you plan to publish has a unique version number. Jcenter and Maven
|
||
|
|
Central will not allow overwriting old versions _unless_ the version is a snapshot.</p>
|
||
|
|
<p>This guide assumes you are trying to publish to net.corda.*. Any other Maven coordinates require approval from Jcenter
|
||
|
|
and Maven Central.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="publishing-locally">
|
||
|
|
<h2>Publishing Locally<a class="headerlink" href="#publishing-locally" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>To publish the codebase locally to Maven Local you must run:</p>
|
||
|
|
<div class="highlight-text"><div class="highlight"><pre><span></span>gradlew install
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This command is an alias for <cite>publishToMavenLocal</cite>.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="publishing-to-jcenter">
|
||
|
|
<h2>Publishing to Jcenter<a class="headerlink" href="#publishing-to-jcenter" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">The module you wish to publish must be linked to jcenter in bintray. Only the founding account can do this.</p>
|
||
|
|
</div>
|
||
|
|
<p>To publish to Jcenter you must first have the following;</p>
|
||
|
|
<ol class="arabic simple">
|
||
|
|
<li>An account on bintray in the R3 organisation</li>
|
||
|
|
<li>Our GPG key’s passphrase for signing the binaries to publish</li>
|
||
|
|
</ol>
|
||
|
|
<div class="section" id="getting-setup">
|
||
|
|
<h3>Getting Setup<a class="headerlink" href="#getting-setup" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>You must now set the following environment variables:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>CORDA_BINTRAY_USER your Bintray username</li>
|
||
|
|
<li>CORDA_BINTRAY_KEY to your bintray API key (found at: <a class="reference external" href="https://bintray.com/profile/edit">https://bintray.com/profile/edit</a>)</li>
|
||
|
|
<li>CORDA_BINTRAY_GPG_PASSPHRASE to our GPG passphrase</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="publishing">
|
||
|
|
<h3>Publishing<a class="headerlink" href="#publishing" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>Once you are setup you can upload all modules in a project with</p>
|
||
|
|
<div class="highlight-text"><div class="highlight"><pre><span></span>gradlew bintrayUpload
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Now login to Bintray and navigate to the corda repository, you will see a box stating you have published N files
|
||
|
|
and asking if you wish to publish. You can now publish to Bintray and Jcenter by clicking this button.</p>
|
||
|
|
<div class="admonition warning">
|
||
|
|
<p class="first admonition-title">Warning</p>
|
||
|
|
<p class="last">Before publishing you should check that all of the files are uploaded and are signed.</p>
|
||
|
|
</div>
|
||
|
|
<p>Within a minute your new version will be available to download and use.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="publishing-to-maven-central">
|
||
|
|
<h2>Publishing to Maven Central<a class="headerlink" href="#publishing-to-maven-central" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>To publish to Maven Central you need the following;</p>
|
||
|
|
<ol class="arabic simple">
|
||
|
|
<li>An admin account on our Bintray R3 organisation</li>
|
||
|
|
<li>A published version in Bintray</li>
|
||
|
|
<li>An account with our Sonatype organisation (Maven Central’s host)</li>
|
||
|
|
</ol>
|
||
|
|
<div class="section" id="id1">
|
||
|
|
<h3>Publishing<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<ol class="arabic simple">
|
||
|
|
<li>Publish to Bintray</li>
|
||
|
|
<li>Navigate to the project you wish to publish</li>
|
||
|
|
<li>Click “Maven Central”</li>
|
||
|
|
<li>Enter your Sonatype credentials to publish a new version</li>
|
||
|
|
</ol>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">The project you publish must be already published to Bintray and the project must be linked to Jcenter</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<footer>
|
||
|
|
|
||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
|
|
||
|
|
<a href="azure-vm.html" class="btn btn-neutral float-right" title="Working with the Corda Demo on Azure Marketplace" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
|
|
||
|
|
|
||
|
|
<a href="building-the-docs.html" class="btn btn-neutral" title="Building the documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<hr/>
|
||
|
|
|
||
|
|
<div role="contentinfo">
|
||
|
|
<p>
|
||
|
|
© Copyright 2016, R3 Limited.
|
||
|
|
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
|
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT:'./',
|
||
|
|
VERSION:'latest',
|
||
|
|
COLLAPSE_INDEX:false,
|
||
|
|
FILE_SUFFIX:'.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
jQuery(function () {
|
||
|
|
SphinxRtdTheme.StickyNav.enable();
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|