blob: 2d65c1a0892d2d26783b861a6b3f3e068112db20 [file] [log] [blame]
<!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>How-to Commit &mdash; Apache Cassandra Documentation v3.11.11</title>
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/extra.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Frequently Asked Questions" href="../faq/index.html" />
<link rel="prev" title="Review Checklist" href="how_to_review.html" />
</head>
<body class="wy-body-for-nav">
<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"> Apache Cassandra
</a>
<div class="version">
3.11.11
</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>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architecture/index.html">Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data_modeling/index.html">Data Modeling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cql/index.html">The Cassandra Query Language (CQL)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/index.html">Configuring Cassandra</a></li>
<li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Cassandra Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="patches.html">Contributing Code Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li>
<li class="toctree-l2"><a class="reference internal" href="license_compliance.html">License Compliance</a></li>
<li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">How-to Commit</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#patch-based-contribution">Patch based Contribution</a></li>
<li class="toctree-l3"><a class="reference internal" href="#git-branch-based-contribution">Git branch based Contribution</a></li>
<li class="toctree-l3"><a class="reference internal" href="#contributions-only-for-release-branches">Contributions only for release branches</a></li>
<li class="toctree-l3"><a class="reference internal" href="#tips">Tips</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Apache Cassandra</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> &raquo;</li>
<li><a href="index.html">Cassandra Development</a> &raquo;</li>
<li>How-to Commit</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/development/how_to_commit.rst.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="how-to-commit">
<h1>How-to Commit<a class="headerlink" href="#how-to-commit" title="Permalink to this headline"></a></h1>
<p>If you are a committer, feel free to pick any process that works for you - so long as you are planning to commit the work yourself.</p>
<div class="section" id="patch-based-contribution">
<h2>Patch based Contribution<a class="headerlink" href="#patch-based-contribution" title="Permalink to this headline"></a></h2>
<p>Here is how committing and merging will usually look for merging and pushing for tickets that follow the convention (if patch-based):</p>
<p>Hypothetical CASSANDRA-12345 ticket is a cassandra-3.0 based bug fix that requires different code for cassandra-3.11, cassandra-4.0, and trunk. Contributor Jackie supplied a patch for the root branch (12345-3.0.patch), and patches for the remaining branches (12345-3.11.patch, 12345-4.0.patch, 12345-trunk.patch).</p>
<dl class="simple">
<dt>On cassandra-3.0:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">am</span> <span class="pre">-3</span> <span class="pre">12345-3.0.patch</span></code> (any problem b/c of CHANGES.txt not merging anymore, fix it in place)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ant</span> <span class="pre">realclean</span> <span class="pre">&amp;&amp;</span> <span class="pre">ant</span> <span class="pre">jar</span> <span class="pre">build-test</span></code> (rebuild to make sure code compiles)</p></li>
</ol>
</dd>
<dt>On cassandra-3.11:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-3.0</span> <span class="pre">-s</span> <span class="pre">ours</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">apply</span> <span class="pre">-3</span> <span class="pre">12345-3.11.patch</span></code> (any issue with CHANGES.txt : fix and <cite>git add CHANGES.txt</cite>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ant</span> <span class="pre">realclean</span> <span class="pre">&amp;&amp;</span> <span class="pre">ant</span> <span class="pre">jar</span> <span class="pre">build-test</span></code> (rebuild to make sure code compiles)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">--amend</span></code> (Notice this will squash the 3.11 applied patch into the forward merge commit)</p></li>
</ol>
</dd>
<dt>On cassandra-4.0:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-3.11</span> <span class="pre">-s</span> <span class="pre">ours</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">apply</span> <span class="pre">-3</span> <span class="pre">12345-4.0.patch</span></code> (any issue with CHANGES.txt : fix and <cite>git add CHANGES.txt</cite>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ant</span> <span class="pre">realclean</span> <span class="pre">&amp;&amp;</span> <span class="pre">ant</span> <span class="pre">jar</span> <span class="pre">build-test</span></code> (rebuild to make sure code compiles)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">--amend</span></code> (Notice this will squash the 4.0 applied patch into the forward merge commit)</p></li>
</ol>
</dd>
<dt>On trunk:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-4.0</span> <span class="pre">-s</span> <span class="pre">ours</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">apply</span> <span class="pre">-3</span> <span class="pre">12345-trunk.patch</span></code> (any issue with CHANGES.txt : fix and <cite>git add CHANGES.txt</cite>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ant</span> <span class="pre">realclean</span> <span class="pre">&amp;&amp;</span> <span class="pre">ant</span> <span class="pre">jar</span> <span class="pre">build-test</span></code> (rebuild to make sure code compiles)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">--amend</span></code> (Notice this will squash the trunk applied patch into the forward merge commit)</p></li>
</ol>
</dd>
<dt>On any branch:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">cassandra-3.0</span> <span class="pre">cassandra-3.11</span> <span class="pre">cassandra-4.0</span> <span class="pre">trunk</span> <span class="pre">--atomic</span> <span class="pre">-n</span></code> (dryrun check)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">cassandra-3.0</span> <span class="pre">cassandra-3.11</span> <span class="pre">cassandra-4.0</span> <span class="pre">trunk</span> <span class="pre">--atomic</span></code></p></li>
</ol>
</dd>
</dl>
</div>
<div class="section" id="git-branch-based-contribution">
<h2>Git branch based Contribution<a class="headerlink" href="#git-branch-based-contribution" title="Permalink to this headline"></a></h2>
<p>Same scenario, but a branch-based contribution:</p>
<dl class="simple">
<dt>On cassandra-3.0:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">cherry-pick</span> <span class="pre">&lt;sha-of-3.0-commit&gt;</span></code> (any problem b/c of CHANGES.txt not merging anymore, fix it in place)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ant</span> <span class="pre">realclean</span> <span class="pre">&amp;&amp;</span> <span class="pre">ant</span> <span class="pre">jar</span> <span class="pre">build-test</span></code> (rebuild to make sure code compiles)</p></li>
</ol>
</dd>
<dt>On cassandra-3.11:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-3.0</span> <span class="pre">-s</span> <span class="pre">ours</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">format-patch</span> <span class="pre">-1</span> <span class="pre">&lt;sha-of-3.11-commit&gt;</span></code> (alternative to format-patch and apply is <cite>cherry-pick -n</cite>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">apply</span> <span class="pre">-3</span> <span class="pre">&lt;sha-of-3.11-commit&gt;.patch</span></code> (any issue with CHANGES.txt : fix and <cite>git add CHANGES.txt</cite>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ant</span> <span class="pre">realclean</span> <span class="pre">&amp;&amp;</span> <span class="pre">ant</span> <span class="pre">jar</span> <span class="pre">build-test</span></code> (rebuild to make sure code compiles)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">--amend</span></code> (Notice this will squash the 3.11 applied patch into the forward merge commit)</p></li>
</ol>
</dd>
<dt>On cassandra-4.0:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-3.11</span> <span class="pre">-s</span> <span class="pre">ours</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">format-patch</span> <span class="pre">-1</span> <span class="pre">&lt;sha-of-4.0-commit&gt;</span></code> (alternative to format-patch and apply is <cite>cherry-pick -n</cite>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">apply</span> <span class="pre">-3</span> <span class="pre">&lt;sha-of-4.0-commit&gt;.patch</span></code> (any issue with CHANGES.txt : fix and <cite>git add CHANGES.txt</cite>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ant</span> <span class="pre">realclean</span> <span class="pre">&amp;&amp;</span> <span class="pre">ant</span> <span class="pre">jar</span> <span class="pre">build-test</span></code> (rebuild to make sure code compiles)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">--amend</span></code> (Notice this will squash the 4.0 applied patch into the forward merge commit)</p></li>
</ol>
</dd>
<dt>On trunk:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-4.0</span> <span class="pre">-s</span> <span class="pre">ours</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">format-patch</span> <span class="pre">-1</span> <span class="pre">&lt;sha-of-trunk-commit&gt;</span></code> (alternative to format-patch and apply is <cite>cherry-pick -n</cite>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">apply</span> <span class="pre">-3</span> <span class="pre">&lt;sha-of-trunk-commit&gt;.patch</span></code> (any issue with CHANGES.txt : fix and <cite>git add CHANGES.txt</cite>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ant</span> <span class="pre">realclean</span> <span class="pre">&amp;&amp;</span> <span class="pre">ant</span> <span class="pre">jar</span> <span class="pre">build-test</span></code> (rebuild to make sure code compiles)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">--amend</span></code> (Notice this will squash the trunk applied patch into the forward merge commit)</p></li>
</ol>
</dd>
<dt>On any branch:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">cassandra-3.0</span> <span class="pre">cassandra-3.11</span> <span class="pre">cassandra-4.0</span> <span class="pre">trunk</span> <span class="pre">--atomic</span> <span class="pre">-n</span></code> (dryrun check)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">cassandra-3.0</span> <span class="pre">cassandra-3.11</span> <span class="pre">cassandra-4.0</span> <span class="pre">trunk</span> <span class="pre">--atomic</span></code></p></li>
</ol>
</dd>
</dl>
</div>
<div class="section" id="contributions-only-for-release-branches">
<h2>Contributions only for release branches<a class="headerlink" href="#contributions-only-for-release-branches" title="Permalink to this headline"></a></h2>
<p>If the patch is for an older branch, and doesn’t impact later branches (such as trunk), we still need to merge up.</p>
<dl class="simple">
<dt>On cassandra-3.0:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">cherry-pick</span> <span class="pre">&lt;sha-of-3.0-commit&gt;</span></code> (any problem b/c of CHANGES.txt not merging anymore, fix it in place)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ant</span> <span class="pre">realclean</span> <span class="pre">&amp;&amp;</span> <span class="pre">ant</span> <span class="pre">jar</span> <span class="pre">build-test</span></code> (rebuild to make sure code compiles)</p></li>
</ol>
</dd>
<dt>On cassandra-3.11:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-3.0</span> <span class="pre">-s</span> <span class="pre">ours</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ant</span> <span class="pre">realclean</span> <span class="pre">&amp;&amp;</span> <span class="pre">ant</span> <span class="pre">jar</span> <span class="pre">build-test</span></code> (rebuild to make sure code compiles)</p></li>
</ol>
</dd>
<dt>On cassandra-4.0:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-3.11</span> <span class="pre">-s</span> <span class="pre">ours</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ant</span> <span class="pre">realclean</span> <span class="pre">&amp;&amp;</span> <span class="pre">ant</span> <span class="pre">jar</span> <span class="pre">build-test</span></code> (rebuild to make sure code compiles)</p></li>
</ol>
</dd>
<dt>On trunk:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">cassandra-4.0</span> <span class="pre">-s</span> <span class="pre">ours</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ant</span> <span class="pre">realclean</span> <span class="pre">&amp;&amp;</span> <span class="pre">ant</span> <span class="pre">jar</span> <span class="pre">build-test</span></code> (rebuild to make sure code compiles)</p></li>
</ol>
</dd>
<dt>On any branch:</dt><dd><ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">cassandra-3.0</span> <span class="pre">cassandra-3.11</span> <span class="pre">cassandra-4.0</span> <span class="pre">trunk</span> <span class="pre">--atomic</span> <span class="pre">-n</span></code> (dryrun check)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">cassandra-3.0</span> <span class="pre">cassandra-3.11</span> <span class="pre">cassandra-4.0</span> <span class="pre">trunk</span> <span class="pre">--atomic</span></code></p></li>
</ol>
</dd>
</dl>
</div>
<div class="section" id="tips">
<h2>Tips<a class="headerlink" href="#tips" title="Permalink to this headline"></a></h2>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<blockquote>
<div><p>A template for commit messages:</p>
</div></blockquote>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>&lt;One sentence description, usually Jira title or CHANGES.txt summary&gt;
&lt;Optional lengthier description&gt;
patch by &lt;Authors&gt;; reviewed by &lt;Reviewers&gt; for CASSANDRA-#####
Co-authored-by: Name1 &lt;email1&gt;
Co-authored-by: Name2 &lt;email2&gt;
</pre></div>
</div>
</div>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>Notes on git flags:
<code class="docutils literal notranslate"><span class="pre">-3</span></code> flag to am and apply will instruct git to perform a 3-way merge for you. If a conflict is detected, you can either resolve it manually or invoke git mergetool - for both am and apply.</p>
<p><code class="docutils literal notranslate"><span class="pre">--atomic</span></code> flag to git push does the obvious thing: pushes all or nothing. Without the flag, the command is equivalent to running git push once per each branch. This is nifty in case a race condition happens - you won’t push half the branches, blocking other committers’ progress while you are resolving the issue.</p>
</div>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The fastest way to get a patch from someone’s commit in a branch on GH - if you don’t have their repo in remotes - is to append .patch to the commit url, e.g.
curl -O <a class="reference external" href="https://github.com/apache/cassandra/commit/7374e9b5ab08c1f1e612bf72293ea14c959b0c3c.patch">https://github.com/apache/cassandra/commit/7374e9b5ab08c1f1e612bf72293ea14c959b0c3c.patch</a></p>
</div>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">cherry-pick</span> <span class="pre">-n</span> <span class="pre">&lt;sha-of-X.X-commit&gt;</span></code> can be used in place of the <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">format-patch</span> <span class="pre">-1</span> <span class="pre">&lt;sha-of-X.X-commit&gt;</span> <span class="pre">;</span> <span class="pre">git</span> <span class="pre">apply</span> <span class="pre">-3</span> <span class="pre">&lt;sha-of-X.X-commit&gt;.patch</span></code> steps.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../faq/index.html" class="btn btn-neutral float-right" title="Frequently Asked Questions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="how_to_review.html" class="btn btn-neutral float-left" title="Review Checklist" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2016, The Apache Cassandra team
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/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">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>