Search 1.9 billion lines of Odoo code on GitHub
smile_ci
<h1 class="title">Continuous Integration</h1>
<p><a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/Smile-SA/odoo_addons/tree/10.0/smile_ci"><img alt="Smile-SA/odoo_addons" src="https://img.shields.io/badge/github-Smile_SA%2Fodoo_addons-lightgray.png?logo=github" /></a></p>
<dl class="docutils">
<dt>Track continuous integration of a project by using different Smile's modules:</dt>
<dd><ul class="first last simple">
<li>smile_docker: <a class="reference external" href="https://github.com/Smile-SA/odoo_addons/tree/10.0/smile_docker">https://github.com/Smile-SA/odoo_addons/tree/10.0/smile_docker</a></li>
<li>smile_scm: <a class="reference external" href="https://github.com/Smile-SA/odoo_addons/tree/10.0/smile_scm">https://github.com/Smile-SA/odoo_addons/tree/10.0/smile_scm</a></li>
<li>smile_test: <a class="reference external" href="https://github.com/Smile-SA/odoo_addons/tree/10.0/smile_ci/addons/smile_test">https://github.com/Smile-SA/odoo_addons/tree/10.0/smile_ci/addons/smile_test</a></li>
</ul>
</dd>
</dl>
<p>Features</p>
<blockquote>
<ul class="simple">
<li><dl class="first docutils">
<dt>Update branch</dt>
<dd><ul class="first last">
<li>For SVN repositories, configure the anonymous login/password</li>
<li>For Git repositories, add read access to the server via SSH key</li>
</ul>
</dd>
</dl>
</li>
<li>Check if changes</li>
<li>Create build</li>
<li><dl class="first docutils">
<dt>Test build (set max_testing to limit concurrent testing builds)</dt>
<dd><ul class="first last">
<li>Create Docker containers
(Odoo server, database engine and other linked services)</li>
<li>Run daemonized Docker containers which starts server in test mode</li>
<li>Check code quality with flake8</li>
<li>Count lines of code with cloc</li>
<li>Create new database with demo or Restore dump in XML/RPC</li>
<li>Install modules in XML/RPC</li>
<li>Let Docker containers run until new builds kill it
(set max_running to limit concurrent running builds)</li>
</ul>
</dd>
</dl>
</li>
<li>Attach log / config / tests result / code coverage files to build</li>
<li>Parse build logs and store results in database</li>
</ul>
</blockquote>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#gdpr-eu-privacy" id="id3">GDPR / EU Privacy</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#author" id="id5">Author</a></li>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
<li><a class="reference internal" href="#maintainer" id="id7">Maintainer</a></li>
</ul>
</li>
</ul>
</div>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id1">Usage</a></h2>
<ol class="arabic">
<li><p class="first">Go to <code>Integration > Configuration > Repositories</code> to create a new repository and add branches:</p>
<blockquote>
<div class="figure">
<img alt="Create Repository" src="static/description/create_repository.png" style="width: 850px;" />
</div>
</blockquote>
</li>
<li><p class="first">Go to <code>Integration > Configuration > Branches</code> to clone and configure the branches:</p>
<blockquote>
<div class="figure">
<img alt="Branch configuration" src="static/description/config_branch.png" style="width: 790px;" />
</div>
<div class="figure">
<img alt="Advanced branch configuration" src="static/description/advanced_config_branch.png" style="width: 790px;" />
</div>
</blockquote>
</li>
<li><p class="first">Test or force the test branch to create a new build:</p>
<blockquote>
<div class="figure">
<img alt="Create a build" src="static/description/create_build.png" style="width: 750px;" />
</div>
<div class="figure">
<img alt="Created a builds" src="static/description/created_builds.png" style="width: 850px;" />
</div>
</blockquote>
</li>
<li><p class="first">You can open a build, show tests result, quality errors and the code coverage of a build via this view:</p>
<blockquote>
<div class="figure">
<img alt="Show build information" src="static/description/show_build_info.png" style="width: 850px;" />
</div>
</blockquote>
</li>
<li><p class="first">Log, config, tests result, code coverage files of a build are attached in this view:</p>
<blockquote>
<div class="figure">
<img alt="Attachments" src="static/description/attachments.png" style="width: 700px;" />
</div>
</blockquote>
</li>
<li><p class="first">To display all builds, go to <code>Integration > Dashboard</code>:</p>
<blockquote>
<div class="figure">
<img alt="Dashboard" src="static/description/dashboard.png" style="width: 850px;" />
</div>
</blockquote>
</li>
</ol>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id2">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/Smile-SA/odoo_addons/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
<a class="reference external" href="https://github.com/Smile-SA/odoo_addons/issues/new?body=module:%20smile_ci%0Aversion:%2010.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">here</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="gdpr-eu-privacy"></a>
<h2><a class="toc-backref" href="#id3">GDPR / EU Privacy</a></h2>
<p>This addons does not collect any data and does not set any browser cookies.</p>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id4">Credits</a></h2>
<a name="author"></a>
<h3><a class="toc-backref" href="#id5">Author</a></h3>
<ul class="simple">
<li>Smile SA</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id6">Contributors</a></h3>
<ul class="simple">
<li>Corentin POUHET-BRUNERIE</li>
<li>Isabelle RICHARD</li>
</ul>
<a name="maintainer"></a>
<h3><a class="toc-backref" href="#id7">Maintainer</a></h3>
<p>This module is maintained by Smile SA.</p>
<p>Since 1991 Smile has been a pioneer of technology and also the European expert in open source solutions.</p>
<a class="reference external image-reference" href="http://smile.fr"><img alt="Smile SA" src="https://avatars0.githubusercontent.com/u/572339?s=200&v=4" /></a>
<p>This module is part of the <a class="reference external" href="https://github.com/Smile-SA/odoo_addons">odoo-addons</a> project on GitHub.</p>
<p>You are welcome to contribute.</p>