2016-05-23 16:05:37 +00:00
<!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 > Release process — 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" / >
2016-05-24 11:27:23 +00:00
< link rel = "next" title = "Release notes" href = "release-notes.html" / >
2016-09-23 09:55:23 +00:00
< link rel = "prev" title = "Client RPC" href = "clientrpc.html" / >
2016-05-23 16:05:37 +00:00
< 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 >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > Overview< / 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 = "data-model.html" > Data model< / a > < / li >
2016-06-30 12:49:28 +00:00
< 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 = "consensus.html" > Consensus model< / a > < / li >
2016-05-23 16:05:37 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "messaging.html" > Networking and messaging< / a > < / li >
2016-10-11 09:30:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "persistence.html" > Persistence< / a > < / li >
2016-08-30 11:05:32 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "creating-a-cordapp.html" > Creating a Cordapp< / a > < / li >
2016-05-23 16:05:37 +00:00
< 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 = "node-administration.html" > Node administration< / a > < / li >
2016-09-23 09:55:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "corda-configuration-files.html" > The Corda Configuration File< / a > < / li >
2016-05-23 16:05:37 +00:00
< / ul >
< p class = "caption" > < span class = "caption-text" > Tutorials< / span > < / p >
< ul >
2016-05-24 11:27:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "where-to-start.html" > Where to start< / a > < / li >
2016-05-23 16:05:37 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-contract.html" > Writing a contract< / a > < / li >
2016-07-12 16:52:52 +00:00
< 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 >
2016-10-11 09:30:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-clientrpc-api.html" > Client RPC API< / a > < / li >
2016-05-23 16:05:37 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "protocol-state-machines.html" > Protocol state machines< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "oracles.html" > Writing oracle services< / a > < / li >
2016-10-11 09:30:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-attachments.html" > Using attachments< / a > < / li >
2016-06-30 12:49:28 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "event-scheduling.html" > Event scheduling< / a > < / li >
2016-09-23 09:55:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "secure-coding-guidelines.html" > Secure coding guidelines< / a > < / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > Contracts< / 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" > Node API< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "clientrpc.html" > Client RPC< / a > < / li >
2016-05-23 16:05:37 +00:00
< / ul >
< p class = "caption" > < span class = "caption-text" > Appendix< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > Release process< / a > < / li >
2016-06-13 17:27:53 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "#steps-to-cut-a-release" > Steps to cut a release< / a > < / li >
2016-05-24 11:27:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "release-notes.html" > Release notes< / a > < / li >
2016-09-23 09:55:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "network-simulator.html" > Network Simulator< / a > < / li >
2016-05-23 16:05:37 +00:00
< 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 >
< / 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 > Release process< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/release-process.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 = "release-process" >
< h1 > Release process< a class = "headerlink" href = "#release-process" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > Corda is under heavy development. The current release process is therefore geared towards rapid iteration.< / p >
< p > Each Corda development release is called a < em > milestone< / em > and has its own branch in the git repository. Milestones are
temporarily stabilised snapshots of the Corda code which are suitable for developers to experiment with. They may
receive backported bugfixes but once announced a milestone will not have any API or backwards compatibility breaks.< / p >
< p > Between milestones backwards compatibility is expected to break. Every new milestone comes with a short announcement
detailing:< / p >
< ul class = "simple" >
< li > What major improvements have been made.< / li >
< li > How to forward port your code to the new milestone.< / li >
< li > What new documentation has become available.< / li >
< li > Important known issues.< / li >
< / ul >
< p > Eventually, Corda will stabilise and release version 1. At that point backwards compatibility will be guaranteed
forever and the software will be considered production ready. Until then, expect it to be a building site and wear your
hard hat.< / p >
< p > Our goal is to cut a new milestone roughly once a month. There are no fixed dates. If need be, a milestone may slip by
2016-06-13 17:27:53 +00:00
a few days to ensure the code is sufficiently usable. Usually the release will happen around the end of the month.< / p >
< / div >
< div class = "section" id = "steps-to-cut-a-release" >
< h1 > Steps to cut a release< a class = "headerlink" href = "#steps-to-cut-a-release" title = "Permalink to this headline" > ¶< / a > < / h1 >
< ol class = "arabic simple" >
< li > Pick a commit that is stable and do basic QA: run all the tests, run the demos.< / li >
< li > Review the commits between this release and the last looking for new features, API changes, etc. Make sure the
summary in the current section of the < a class = "reference internal" href = "release-notes.html" > < span class = "doc" > Release notes< / span > < / a > is correct and update if not. Then move it into the right
section for this release. This is the right place to put any advice on how to port app code from the last release.< / li >
< li > Additionally, if there are any new features or APIs that deserve a new section in the docsite and the author didn’ t
create one, bug them to do so a day or two before the release.< / li >
< li > Regenerate the docsite if necessary and commit.< / li >
< li > Create a branch with a name like < cite > release-M0< / cite > where 0 is replaced by the number of the milestone.< / li >
2016-07-12 16:52:52 +00:00
< li > Adjust the version in the root build.gradle file to take out the -SNAPSHOT and commit it on the branch.< / li >
2016-08-30 11:05:32 +00:00
< li > Remove the “ is master” warning from the docsite index page on this branch only.< / li >
2016-07-12 16:52:52 +00:00
< li > Tag the branch with a tag like < cite > release-M0.0< / cite > < / li >
2016-06-13 17:27:53 +00:00
< li > Push the branch and the tag to git.< / li >
2016-08-30 11:05:32 +00:00
< li > Write up a short announcement containing the summary of new features, changes, and API breaks. Send it to the r3dlg-awg mailing list.< / li >
2016-07-12 16:52:52 +00:00
< li > On master, adjust the version number in the root build.gradle file upwards.< / li >
2016-06-13 17:27:53 +00:00
< / ol >
< p > If there are serious bugs found in the release, backport the fix to the branch and then tag it with e.g. < cite > release-M0.1< / cite >
Minor changes to the branch don’ t have to be announced unless it’ d be critical to get all developers updated.< / p >
2016-05-23 16:05:37 +00:00
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2016-05-24 11:27:23 +00:00
< a href = "release-notes.html" class = "btn btn-neutral float-right" title = "Release notes" accesskey = "n" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2016-05-23 16:05:37 +00:00
2016-09-23 09:55:23 +00:00
< a href = "clientrpc.html" class = "btn btn-neutral" title = "Client RPC" accesskey = "p" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2016-05-23 16:05:37 +00:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2016, Distributed Ledger Group, LLC.
< / 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 >
